|
| 1 | +--- |
| 2 | +title: Make it Count |
| 3 | +date: 2025-09-30 |
| 4 | +page.meta.tags: programming, practices, code-review |
| 5 | +page.meta.categories: programming |
| 6 | +--- |
| 7 | + |
| 8 | +Code review is part of daily life for many software engineers. It's a great way |
| 9 | +to learn and share what you know. Code review is the time for a team to take |
| 10 | +a breath, look at an implementation and navigate changes before the PR merges |
| 11 | +and becomes part of the teams public responsibility. |
| 12 | + |
| 13 | +> Every team does code review different. If you're new to code review, or want |
| 14 | +> https://google.github.io/eng-practices/review/reviewer/ to see a well documented |
| 15 | +> process to the practice maybe take a second to checkout [Google's review practices](https://google.github.io/eng-practices/review/reviewer/). |
| 16 | +
|
| 17 | +While I think code review is critical to maintaining a healthy codebase, project |
| 18 | +and team, I've also started to notice the trend of "nits" in the last few years. |
| 19 | +Nits are small comments that don't really add value to the code review. They |
| 20 | +are largely subjective, and for the most part, don't really help the code. |
| 21 | + |
| 22 | +> For doc PRs these are typically grammar or spelling, which should be called |
| 23 | +> out, and ideally corrected using existing tools pre review. |
| 24 | +
|
| 25 | +Instead they riddle the review with noise possibly masking more important comments, |
| 26 | +and typically indicate a lack of understanding the architecture or context of |
| 27 | +the PR. Alternatively they can be a sign that a reviewer feels like they have to |
| 28 | +say something, or find something that needs to be changed. While any given PR |
| 29 | +probably has something that could be improved (depending on the level of pedantry |
| 30 | +we want to apply) it's important to consider the goal of code review, if the |
| 31 | +comment truly improves the project/team, or if it's inconsequential. These |
| 32 | +inconsequential comments don't move the project forward, and in some ways impede |
| 33 | +the project by burdening the team, and causing unnecessary review loops. Instead |
| 34 | +as a reviewer consider the teams goals and the PR's goals, and focus on comments |
| 35 | +that help achieve those goals, benefit the project and grow the team. Make it |
| 36 | +count. |
0 commit comments