Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
devleejb committed Nov 15, 2024
1 parent 462e21e commit c0c602b
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,14 @@ If you have any questions along the way, please don’t hesitate to ask us

This is a rough outline of what a contributor's workflow looks like:

- Create a topic branch from where to base the contribution. This is usually main
- Make commits of logical units
- Make sure commit messages are in the proper format
- Push changes in a topic branch to a personal fork of the repository
- Submit a pull request to yorkie-team/codepair
- The PR must receive a LGTM from maintainers
1. Create a topic branch from where to base the contribution (usually main).
2. Make commits of logical units.
- Make sure all tests pass, and add any new tests as appropriate.
- Make sure commit messages are in the proper format (see below).
3. Push changes in a topic branch to the forked repository.
4. Submit a pull request to the original repository.
5. Address any review comments from CodeRabbit and maintainers.
6. After receiving LGTM from maintainers, the PR will be merged.

Thanks for contributing!

Expand Down Expand Up @@ -79,6 +81,11 @@ The first line is the subject and should be no longer than 70 characters, the se
6. **Pull Request**
Submit a pull request for review.

## Code Review

We use GitHub's pull request review feature to review code. We also use CodeRabbit to automate code review for reducing the effort of maintainers. CodeRabbit will automatically review your pull request and provide feedback on code quality, test coverage, and more.
We require that all code is reviewed by at least one maintainer before being merged. We may ask for changes to be made to the code before it is merged.

## Contributor License Agreement

We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution.
Expand Down

0 comments on commit c0c602b

Please sign in to comment.