Created
May 13, 2024 11:36 AM
Tags
This template documents how to review code. Helpful for new and remote employees to get and stay aligned.
PhilosophyPreparing Code for ReviewCommit MessagesGithub PR DescriptionsPerforming Code ReviewsHow to ReviewExamples
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: TqSdk介绍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
You might suggest that this be a
let instead of var.