Skip to content

Commit

Permalink
Merge pull request #5 from dimagi/orangejenny-patch-1
Browse files Browse the repository at this point in the history
Update code review guidelines
  • Loading branch information
orangejenny authored Sep 19, 2019
2 parents c737a77 + f26a6d7 commit 5baaa21
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ At a very high level, the code review process should go as follows:

- Author submits code to be reviewed and pings reviewer(s)
- Reviewers review the code and leave feedback for the author
- When the reviewers are satisfied with the changes, they merge the code
- Once a reviewer has marked the PR approved, the author can merge the code.

In general, the onus is on the author to convince the reviewer that the changes are acceptable. However, the onus is on the reviewer to ensure that the changes requested are reasonable.

Expand All @@ -32,6 +32,8 @@ Reviewing code is hard, and as the author of code you should try your best to ma

Read the page on [Writing PRs](https://github.com/dimagi/code-review/blob/es/writing-prs/Writing_PRs.md)

Also look at Google's guide to [getting through code reviews](https://google.github.io/eng-practices/review/developer/)

### Responding to feedback

Here are some guidelines for authors responding to feedback during code review.
Expand All @@ -54,6 +56,8 @@ The author likely put a lot of work into the code that they wrote. As such it is
- For any “blockers” make sure that you communicate (respectfully) why they are blockers (see below).
- If you don’t feel like you have enough context to understand and merge the change, don’t hesitate to ask for an additional reviewer who has more context.

Also look at Google's guide to [how to do a code review](https://google.github.io/eng-practices/review/reviewer/)

### Blockers

A “blocker” is a change that the reviewer requests be made before the code is merged. A blocker should typically be in one of the following categories:
Expand Down

0 comments on commit 5baaa21

Please sign in to comment.