Code reviews improve code quality and share knowledge across the team.
For Authors#
Before Requesting Review#
- Self-review the diff first
- Ensure tests pass
- Write clear PR description
- Keep PRs focused and small (<400 lines)
Good PR Description#
1## Summary
2Add user authentication using JWT
3
4## Changes
5- Add login/registration endpoints
6- Implement JWT token validation
7- Add auth middleware
8
9## Testing
10- Unit tests for auth service
11- Integration tests for endpointsFor Reviewers#
Comment Types#
1// š“ Blocking: Must fix
2// "This will cause a memory leak"
3
4// š” Suggestion: Consider changing
5// "Consider using const instead of let"
6
7// š¢ Nitpick: Optional
8// "We typically put helpers at bottom"
9
10// š Praise: Good work
11// "Nice solution to the caching problem"Constructive Feedback#
ā Bad: "This is wrong"
ā
Good: "This might throw if user is null. Consider adding a null check."Review Checklist#
- Does it solve the problem?
- Is it tested?
- Is error handling appropriate?
- Any security concerns?
Focus on important issues, be constructive, and remember reviews are about shipping better software together.