Skip to content
This repository has been archived by the owner on Jun 14, 2023. It is now read-only.

Latest commit

 

History

History
99 lines (60 loc) · 3.27 KB

communication.rst

File metadata and controls

99 lines (60 loc) · 3.27 KB
Raw

Code Review

A guide for reviewing code and having your code reviewed.

  • Accept that many programming decisions are opinions. Discuss trade offs, which you prefer, and reach a resolution quickly;
  • Ask questions; don't make demands. ("What do you think about naming this userId?")
  • Ask for clarification. ("I didn't understand. Can you clarify?")
  • Avoid selective ownership of code. ("mine", "not mine", "yours")
  • Avoid using terms that could be seen as referring to personal traits. ("dumb", "stupid"). Assume everyone is attractive, intelligent, and well-meaning;
  • Be explicit. Remember people don't always understand your intentions online;
  • Be humble. ("I'm not sure - let's look it up.");
  • Don't use hyperbole. ("always", "never", "endlessly", "nothing");
  • Don't use sarcasm;
  • Keep it real. If emoji, animated gifs, or humor aren't you, don't force them; If they are, use them with aplomb;
  • Talk in person if there are too many "I didn't understand" or "Alternative solution:" comments. Post a follow-up comment summarizing offline discussion;

Having Your Code Reviewed

  • Be grateful for the reviewer's suggestions. ("Good call. I'll make that change.");
  • Don't take it personally. The review is of the code, not you;
  • Explain why the code exists. ("It's like that because of these reasons. Would it be more clear if I rename this class/file/method/variable?");
  • Extract some changes and refactorings into future tickets/stories;
  • Link to the code review from the ticket/story. ("Ready for review: https://github.com/organization/project/pull/1")
  • Push commits based on earlier rounds of feedback as isolated commits to the branch. Do not squash until the branch is ready to merge. Reviewers should be able to read individual updates based on their earlier feedback;
  • Seek to understand the reviewer's perspective;
  • Try to respond to every comment;

Maintainers

  • Wait to merge the branch until Continuous Integration (StyleCI, TravisCI, etc.) tells you the test suite is green in the branch;
  • Merge once you feel confident in the code and its impact on the project;

Reviewing Code

Understand why the code is necessary (bug, user experience, refactoring). Then:

  • Communicate which ideas you feel strongly about and those you don't;
  • Identify ways to simplify the code while still solving the problem;
  • If discussions turn too philosophical or academic, move the discussion offline to a regular Friday afternoon technique discussion. In the meantime, let the author make the final decision on alternative implementations;
  • Offer alternative implementations, but assume the author already considered them. ("What do you think about using a custom validator here?")
  • Seek to understand the author's perspective;
  • Sign off on the pull request with a 👍 or "Ready to merge" comment;

Style Comments

Reviewers should comment on missed :doc:`/code/standards`.

Example comment:

> Order resourceful routes alphabetically by name.

An example response to style comments:

Whoops. Good catch, thanks. Fixed in a4994ec.

If you disagree with a guideline, open an issue on the guides repo rather than debating it within the code review. In the meantime, apply the guideline.