code_review_guide.md · ShiZhaoQuan/tidb - Gitee.com

forked from 平凯星辰（北京）科技有限公司/tidb

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

克隆/下载

code_review_guide.md 2.02 KB

# Code Review Guide

## Things to do before you start reviewing the PR

* Make sure you are familiar with the packages the PR modifies.

* Make sure you have enough continuous time to review the PR, use 300 LOC per hour to estimate.

* Make sure you can follow the updates of the PR in the next few work days.

* Read the description of the PR, if it's not easy to understand, ask the coder to improve it.

* For a bug fix PR, if there is no test case, ask the coder to add tests.

* For a performance PR, if no benchmark result is provided, ask the coder to add a benchmark result.

## Things to check during the review process

* Am I able to understand the purpose of each unit test?

* Do unit tests actually test that the code is performing the intended functionality?

* Do unit tests cover all the important code blocks and specially handled errors?

* Could procedure tests be rewritten to table driven tests?

* Is the code written following the style guide?

* Is the same code duplicated more than twice?

* Do comments exist and describe the intent of the code?

* Are hacks, workarounds and temporary fixes commented?

* Does this function do more than the name suggests?

* Can this function's behavior be inferred by its name?

* Do tests exist and are they comprehensive?

* Do unit tests cover all the important code branches?

* Could the test code be extracted into a table-driven test?

## Things to keep in mind when you are writing a review comment

* Be kind to the coder, not to the code.

* Ask questions rather than make statements.

* Treat people who know less than you with respect, deference, and patience.

* Remember to praise when the code quality exceeds your expectation.

* It isn't necessarily wrong if the coder's solution is different than yours.

* Refer to the code style document when necessary.

## Things to remember after you submitted the review comment

* Checkout Github notification regularly to keep track of the updates of the PR.

* When the PR has been updated, start another round of review or give it a LGTM.

一键复制编辑原始数据按行查看历史

提交于 2017-04-29 00:07 . doc: add code review guide. (#3166)

# Code Review Guide

## Things to do before you start reviewing the PR

* Make sure you are familiar with the packages the PR modifies.

* Make sure you have enough continuous time to review the PR, use 300 LOC per hour to estimate.

* Make sure you can follow the updates of the PR in the next few work days.

* Read the description of the PR, if it's not easy to understand, ask the coder to improve it.

* For a bug fix PR, if there is no test case, ask the coder to add tests.

* For a performance PR, if no benchmark result is provided, ask the coder to add a benchmark result.

## Things to check during the review process

* Am I able to understand the purpose of each unit test?

* Do unit tests actually test that the code is performing the intended functionality?

* Do unit tests cover all the important code blocks and specially handled errors?

* Could procedure tests be rewritten to table driven tests?

* Is the code written following the style guide?

* Is the same code duplicated more than twice?

* Do comments exist and describe the intent of the code?

* Are hacks, workarounds and temporary fixes commented?

* Does this function do more than the name suggests?

* Can this function's behavior be inferred by its name?

* Do tests exist and are they comprehensive?

* Do unit tests cover all the important code branches?

* Could the test code be extracted into a table-driven test?

## Things to keep in mind when you are writing a review comment

* Be kind to the coder, not to the code.

* Ask questions rather than make statements.

* Treat people who know less than you with respect, deference, and patience.

* Remember to praise when the code quality exceeds your expectation.

* It isn't necessarily wrong if the coder's solution is different than yours.

* Refer to the code style document when necessary.

## Things to remember after you submitted the review comment

* Checkout Github notification regularly to keep track of the updates of the PR.

* When the PR has been updated, start another round of review or give it a LGTM.

马建仓 AI 助手

尝试更多

代码解读

代码找茬

代码优化

Go

1

https://gitee.com/shizhaoquan/tidb.git

git@gitee.com:shizhaoquan/tidb.git

shizhaoquan

tidb

tidb

master