..
Code Review Checklist
Best Practices
- Be Polite and Professional
- Write Small Changes
- Write Good Change Descriptions
- Communicate explicitly
My Code Review Checklist
| No | Description |
|---|---|
| 0 | CR description is clear |
| 1 | CR description is matched with commit description |
| 2 | Typo |
| 3 | indentation, spacing, naming conventions |
| 4 | Comments. Whys and whats |
| 5 | Easy to read. Avoid 1-liners |
| 6 | Dead codes. Is code commented out? |
| 7 | Are there obvious bugs? |
| 8 | Are there unit tests and have they been run? Are they adequate? |
| 9 | Does the design make sense? |
| 10 | Does the change cover the design requirements? |
| 11 | Duplicated code? |
| 12 | Constants. Magic numbers? |
| 13 | Initialize the default values |
| 14 | Backward compatible? |
| 15 | Dependencies. Introduce new dependencies? Break it? |
| 16 | Failure handling? Edge cases handling? |
| 17 | Performance? |
| 18 | How to debug? Does code have logging? Impact on performance? |
| 19 | Security |
| 20 | Variable, function names explain themselves |