How-to article
Explain step by step how to do one task.
Agree on how the team reviews code - what to check and how to give feedback.
Owner | @mention the owner |
Last reviewed |
Two or three sentences: why your team reviews code. For example, to find problems early, to share knowledge and to keep the code easy to change.
Area | Questions to ask |
|---|---|
Correctness | Does the code do what the description says? What happens with empty, wrong or very large input? Does it handle errors? |
Design | Is this the right place for the change? Is there a simpler way? Does it repeat code that already exists? |
Tests | Do the tests cover the new behavior and the edge cases? Does a test fail if the code breaks? |
Readability | Can a new team member understand the code? Are the names clear? Do the comments say why, not what? |
Security | Does the code check user input? Are secrets kept out of the code and the logs? Does it respect permissions? |
Another area, for example performance | The questions to ask for this area |
✅ Do
🚫 Do not
Approve when the change makes the code better and has no problem that the author must fix. A change does not have to be perfect.
Your team's rules: for example, how many approvals a change needs, and who can merge it.