milvus-io
/
milvus
mirror of https://github.com/milvus-io/milvus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[skip ci]Format markdown doc for CODE_REVIEW.md (#10043) 

Signed-off-by: ruiyi.jiang <ruiyi.jiang@zilliz.com>
pull/10046/head
ryjiang 2021-10-17 16:46:34 +08:00 committed by GitHub
parent 3655792fac
commit 8c7765b2b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
CODE_REVIEW.md
View File

@ -4,8 +4,8 @@ All PRs are checked in automatically by the sre-robot, with the following condit
1. DCO check passed
2. All test passed and code coverage check passed, with a `ci-passed` label
4. Reviewe passed, with a `lgtm` label
5. Approver passed, with a `approved` label
3. Reviewe passed, with a `lgtm` label
4. Approver passed, with a `approved` label
Generally speaking, reviewer is volunteered and can be anyone in the community who is familiar with the packages the PR modifies.
Reviewers are responsible for the logic correctness, error handling, unit test coverage and code readability.
@ -13,67 +13,64 @@ While Approver focus on overall design, code readability, and ensuring the PR fo
conduct(Such as meaningful title and commit message, marked with correct labels, meaningful comments). Currently,
all Approvers are listed under OWNERS_ALIASES file.
## Things to do before review
* Read the title, commit message and related issue of the PR, if it's not easy to understand, ask for improvement
- Read the title, commit message and related issue of the PR, if it's not easy to understand, ask for improvement
* For a bug fix PR, there should be a detailed bug description in related issue, and make sure there test cases to cover this bug.
- For a bug fix PR, there should be a detailed bug description in related issue, and make sure there test cases to cover this bug.
* For a function enhancement PR, understand the function use case, make sure the functionality is reasonable.
- For a function enhancement PR, understand the function use case, make sure the functionality is reasonable.
* For a performance PR, make sure benchmark result is listed in PR.
* Think deeply about why is the solution necessary, any workaround or substitutions?
- For a performance PR, make sure benchmark result is listed in PR.
- Think deeply about why is the solution necessary, any workaround or substitutions?
## Things to check during the review
* Does the code follow style guide?
- Does the code follow style guide?
* Does the code do excatly the same as title and commit message describe?
- Does the code do excatly the same as title and commit message describe?
* Can this function and variable's behavior be inferred by its name
- Can this function and variable's behavior be inferred by its name
* Do unit tests cover all the important code branches?
- Do unit tests cover all the important code branches?
* What about the edge cases and failure handling path?
- What about the edge cases and failure handling path?
* Do we need better layering and abstraction?
- Do we need better layering and abstraction?
* Are there enough comments to understand the intent of the code?
* Are hacks, workarounds and temporary fixes commented?
- Are there enough comments to understand the intent of the code?
- Are hacks, workarounds and temporary fixes commented?
## Things to keep in mind when you are writing a review comment
* Be kind to the coder, not to the code.
- Be kind to the coder, not to the code.
* Ask questions rather than make statements.
- Ask questions rather than make statements.
* Treat people who know less than you with respect, deference, and patience.
- Treat people who know less than you with respect, deference, and patience.
* Remember to praise when the code quality exceeds your expectation.
- Remember to praise when the code quality exceeds your expectation.
* It isn't necessarily wrong if the coder's solution is different than yours.
- It isn't necessarily wrong if the coder's solution is different than yours.
* Community is not only about the product, it is about person. Help others to improve whenever possible.
- Community is not only about the product, it is about person. Help others to improve whenever possible.
## For Approvers
## For Approvers
Besides All the reviewer's responsibility listed above, Approvers should also maintain code of conduct.
* Be sure the pr has only one commit, author has to do a squash commit in local REPO
- Be sure the pr has only one commit, author has to do a squash commit in local REPO
* Commit message starts with a capital letter and does not end with punctuation
- Commit message starts with a capital letter and does not end with punctuation
* Commit message is clear and meaningful. You can only have title but no body if the title is self explained
- Commit message is clear and meaningful. You can only have title but no body if the title is self explained
* PR links to the correct issue, which clearly states the problems to be solved and the planned solution
- PR links to the correct issue, which clearly states the problems to be solved and the planned solution
* PR sets kind label
- PR sets kind label
* The variable names appearing in the source code need to be readable. Comments are necessary if it is a unusual abbreviations
- The variable names appearing in the source code need to be readable. Comments are necessary if it is a unusual abbreviations
Thanks for [Code Review Guide](https://github.com/pingcap/tidb/blob/master/code_review_guide.md) from Pingcap community.