Update CONTRIBUTING.md and PULL_REQUEST_TEMPLATE.md

yorkie-team · Nov 15, 2024 · 5ec26f2 · 5ec26f2
1 parent f8ebba2
commit 5ec26f2
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,20 +3,24 @@
 **What this PR does / why we need it**:
 
 **Which issue(s) this PR fixes**:
+
 <!--
 *Automatically closes linked issue when PR is merged.
 Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
 -->
+
 Fixes #
 
 **Special notes for your reviewer**:
 
 **Does this PR introduce a user-facing change?**:
+
 <!--
 If no, just write "NONE" in the release-note block below.
 If yes, a release note is required:
 Enter your extended release note in the block below. If the PR requires additional action from users switching to the new release, include the string "action required".
 -->
+
 ```release-note
 
 ```
@@ -30,10 +34,13 @@ Please use the following format for linking documentation:
 - [Usage]: <link>
 - [Other doc]: <link>
 -->
+
 ```docs
 
 ```
 
 **Checklist**:
+
 - [ ] Added relevant tests or not required
+- [ ] Addressed and resolved all CodeRabbit review comments
 - [ ] Didn't break anything
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -22,7 +22,8 @@ This is a rough outline of a contributor's workflow:
    - Make sure commit messages are in the proper format (see below).
 7. Push changes in a topic branch to the forked repository.
 8. Submit a pull request to the original repository.
-9. After receiving LGTM from maintainers, the PR will be merged.
+9. Address any review comments from CodeRabbit and maintainers.
+10. After receiving LGTM from maintainers, the PR will be merged.
 
 Thanks for contributing!
 
@@ -103,6 +104,12 @@ We are using [Codecov](https://about.codecov.io) for analyzing PR's code coverag
 make coverage
 ```
 
+### 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 (CLA)
 
 We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution.