Skip to content

Code Review Guide

Hanna Nekhniadovich edited this page Dec 13, 2018 · 1 revision

Code Review

A guide for reviewing code and having your code reviewed.

Everyone

  • Accept that many programming decisions are opinions. Discuss trade offs, which you prefer, and reach a resolution quickly.
  • Be nice, communication is key.
  • Ask good questions; don't make demands.
  • Everyone's working schedule is different so tried to be mindful.

Review

  • Test your code and pass all CI testing.
  • Request a code review before merging.
  • Add comments to your code and commits.
  • Be explicit. Remember people don't always understand your approach.

Review Process Change For Final release

  • No more using LGTM to approve PR
  • For each Pull Request Everyone should write at least 2 sentences for Approving a PR
  • No PR should be opened for more that 2 hours if it was created between 10am - 10pm The code review process we have so far is good but i think we need a little bit more substance in the reviews

Done

  • Merge once you feel confident in the code and its impact on the project.