<aside> 💡 This template documents how to review code. Helpful for new and remote employees to get and stay aligned.

</aside>

Philosophy

Code reviews ensure the good work. Every developer is responsible for the quality of the code that he/she produces. We use automatic tools to ensure that all the code that lands to the repo is good formatted and well tested code.

Preparing Code for Review

Preparation sets your reviewers up for success.

Commit Messages

Make sure your commit messages are descriptive.

Github PR Descriptions

Your PR descriptions should be an extension of your commit messages. Write about both what the commit changes, and how you implemented the change.

Performing Code Reviews

How to Review

• Make two passes over the PR if it's substantial.
  • On the first pass, come to an understanding of the code change at a high level.
  • On the second pass, pay more attention to semantic details.
• Follow the instructions for reviewing code locally
  • Run `

Examples

var commentCount = 0;

You might suggest that this be a let instead of var.