Skip to content

Commit c9a9a3e

Browse files
authored
A few small tweaks
I rewrote a handful of sentences for better flow and/or meaning.
1 parent 9e81129 commit c9a9a3e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

code-review.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Code Review Guidelines
22

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
55
of a review, and reviewers should state the performed actions and areas of
66
focus.
77

@@ -19,7 +19,7 @@ __As code author (pre-review):__
1919
pass, etc. *Do not waste the reviewer's time with things you can easily get
2020
right in the first place!*
2121

22-
1. Send a PR, that follows our [PR
22+
1. Send a PR that follows our [PR
2323
guideline](commits.md#pull-request-guidelines-wip), and describe what you
2424
think are the aspects that require the largest share of a reviewer's
2525
attention:
@@ -30,8 +30,8 @@ __As code author (pre-review):__
3030
feature, or by leaving a comment on the *pull request* page, mentioning the
3131
desired
3232
[`@<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.
3535

3636

3737
__As code reviewer:__
@@ -46,7 +46,7 @@ __As code reviewer:__
4646
e.g. if a docs PR adds URLs, check if they actually resolve, etc.
4747
Be diligent, but also remember that the goal is not to demonstrate your
4848
review skills but to integrate the proposed bug fix or feature. And be
49-
respectful.
49+
respectful in word choice and tone.
5050

5151
1. Mention the areas (topical, regional) you focused on. Feel free to mention
5252
areas you cannot review as well:
@@ -56,9 +56,9 @@ __As code reviewer:__
5656
__As code author (post-review):__
5757

5858
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!*
6060

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
6262
something wrong.
6363

6464
- Otherwise, push new commits that address the comment. These commits

0 commit comments

Comments
 (0)