add reviewer reminder (#299)

Signed-off-by: pingyu <[email protected]> Signed-off-by: pingyu <[email protected]>
tikv · Nov 7, 2022 · 8e9f8a5 · 8e9f8a5
1 parent b07ce74
commit 8e9f8a5
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -43,3 +43,17 @@ This PR has been tested by at least one of the following methods:
 - Need to update the documentation
 - Need to be included in the release note
 - No related changes
+
+### To reviewers
+
+<!-- Please keep the following text as a reminder to PR reviewers -->
+Please follow these principles to check this pull requests:
+
+- **Concentration**. One pull request should only do one thing. No matter how small it is, the change does exactly one thing and gets it right. Don't mix other changes into it.
+- **Tests**. A pull request should be test covered, whether the tests are unit tests, integration tests, or end-to-end tests. Tests should be sufficient, correct and don't slow down the CI pipeline largely.
+- **Functionality**. The pull request should implement what the author intends to do and fit well in the existing code base, resolve a real problem for TiDB/TiKV users. To get the author's intention and the pull request design, you could follow the discussions in the corresponding GitHub issue or [internal.tidb.io](https://internals.tidb.io) topic.
+- **Style**. Code in the pull request should follow common programming style. *(For Go, we have style checkers in CI)*. However, sometimes the existing code is inconsistent with the style guide, you should maintain consistency with the existing code or file a new issue to fix the existing code style first.
+- **Documentation**. If a pull request changes how users build, test, interact with, or release code, you must check whether it also updates the related documentation such as READMEs and any generated reference docs. Similarly, if a pull request deletes or deprecates code, you must check whether or not the corresponding documentation should also be deleted.
+- **Performance**. If you find the pull request may affect performance, you could ask the author to provide a benchmark result.
+
+*(The above text mainly refers to [TiDB Development Guide](https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/review-a-pr.html#checking-pull-requests). It's also highly recommended to read about [Writing code review comments](https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/review-a-pr.html#writing-code-review-comments))*