Google’s code review practices
19 points by xSavitar
19 points by xSavitar
I’ve linked to this guide a million times. Especially the part on small changes: https://google.github.io/eng-practices/review/developer/small-cls.html
Producing small changes and not using tools that get in the way of doing that is maybe the single most important thing when it comes to making code review good.
Producing small changes and not using tools that get in the way of doing that
It's really depressing to me to think how much the industry is held back by everyone using GitHub with its awful design and active hostility to good practices.
Yes @altano. I agree with you that keeping a change relatively small has a very positive effect on code review systems in general. For one, it attracts code reviewers because the change is relatively small to “figure” out / comprehend.
But sometimes, a small change can be as a result of lots of digging into the codebase/problem, to figure out the root cause of the issue. A small change doesn’t necessarily mean a simple change, in this case.
When a change is relatively small but not very simple, a good commit message can help in explaining all the technical decisions made before arriving at the conclusion. It can be a good place in helping the reviewer understand what the change author did behind the scenes.