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

</aside>

Philosophy

Why do you perform code reviews? What are your guiding principles for these reviews?

You may want to mention other pages here. Like Engineering Guidelines. To link to another page inline, type @ followed by the name of the page: Engineering guidelines

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.

Examples

var commentCount = 0;

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