Code reviews
Code reviews are a core part of our development process. Here is a short writeup on what we find important in code reviews.
Purpose¶
The purpose of a code review are two-fold:
- ensure a high quality codebase
- share knowledge
Items to review¶
- Does the code style, naming match our conventions?
- Does the code conform to our best practices?
- Does the code fit in the overall architecture? Is this functionality duplicated somewhere else?
- Are there tests for the code change?
- Is this code maintainable going forward?
- If the person doing the review is familiar with the user story (likely on the same team), check whether the implemented logic looks correct
Comments / feedback / process¶
- Record comments on the MR
- If comments are a matter of style or choice, but don't necessarily need to be changed, indicate them as a nitpick. The PR can be merged without the nits being resolved.
- In a sprint, pick up code reviews ASAP, it is the shortest path to getting something valuable into the product
Reference¶
Check this blog post for more details on how we see and do code reviews.