Skip to content

Commit 9961e3e

Browse files
committed
Add section on reviewing code
1 parent 4849e95 commit 9961e3e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,13 @@ This does _not_ mean that
8787
In summary, understand the context of the features that you port, in order to avoid [_cargo-culting_](https://en.wikipedia.org/wiki/Cargo_cult_programming), and to be mindful of [Chesterton's fence](https://en.wiktionary.org/wiki/Chesterton%27s_fence).
8888

8989

90+
## Reviewing code
91+
92+
When reviewing pull requests, try to understand and give feedback on the high-level design first, before commenting on coding style, safety comments and such.
93+
94+
Use the "changes requested" status sparingly, and instead consider simply leaving comments. This enables other reviewers to approve the pull requests when they see that all requested changes have been made. Conversely, if you are a reviewer and see that someone else has left comments requesting changes, it's expected that you ensure that all of them have been addressed before you approve.
95+
96+
9097
## License
9198
Any contribution that you make to this repository will
9299
be under the Apache 2 License, as dictated by that

0 commit comments

Comments
 (0)