1
1
# Code Review Guidelines
2
2
3
- Code reviews are important, both to ensure code quality, and to learn from each
4
- other. To get the most out of it , code authors should voice their expectations
3
+ Code reviews are important, not only to ensure code quality, but also so project team members can learn from each
4
+ other. To get the most out of the process , code authors should voice their expectations
5
5
of a review, and reviewers should state the performed actions and areas of
6
6
focus.
7
7
@@ -19,7 +19,7 @@ __As code author (pre-review):__
19
19
pass, etc. * Do not waste the reviewer's time with things you can easily get
20
20
right in the first place!*
21
21
22
- 1 . Send a PR, that follows our [ PR
22
+ 1 . Send a PR that follows our [ PR
23
23
guideline] ( commits.md#pull-request-guidelines-wip ) , and describe what you
24
24
think are the aspects that require the largest share of a reviewer's
25
25
attention:
@@ -30,8 +30,8 @@ __As code author (pre-review):__
30
30
feature, or by leaving a comment on the * pull request* page, mentioning the
31
31
desired
32
32
[ ` @<reviewer> ` ] ( https://help.github.com/en/articles/basic-writing-and-formatting-syntax#mentioning-people-and-teams ) .
33
- Don't be afraid to remind them, if no one has been on it after a couple of
34
- days.
33
+ Don't be afraid to send a reminder after a couple of
34
+ days if no one has addressed your request .
35
35
36
36
37
37
__ As code reviewer:__
@@ -46,7 +46,7 @@ __As code reviewer:__
46
46
e.g. if a docs PR adds URLs, check if they actually resolve, etc.
47
47
Be diligent, but also remember that the goal is not to demonstrate your
48
48
review skills but to integrate the proposed bug fix or feature. And be
49
- respectful.
49
+ respectful in word choice and tone .
50
50
51
51
1 . Mention the areas (topical, regional) you focused on. Feel free to mention
52
52
areas you cannot review as well:
@@ -56,9 +56,9 @@ __As code reviewer:__
56
56
__ As code author (post-review):__
57
57
58
58
1 . Address ** all (!)** review comments. * Do not waste the reviewer's time by
59
- having them leave the same comment twice!*
59
+ forcing them to leave the same comment twice!*
60
60
61
- - Reply to the comment, if it is unclear, or you think the reviewer got
61
+ - Reply to the comment if it is unclear or you think the reviewer got
62
62
something wrong.
63
63
64
64
- Otherwise, push new commits that address the comment. These commits
0 commit comments