Started writing a short doc before every task and my code reviews got quieter
Simple habit that changed a lot for me: before I touch code, I write a few sentences in the ticket about what I'm going to change and why. Takes ten minutes.
Two things happened. First, half the time I catch a bad approach before writing a line. Second, my reviewers stopped leaving "why did you do it this way?" comments because the answer's already there. My PRs merge faster now, and I'm not even writing better code, I'm just explaining it up front.
2 comments
- 0
AnonymousAnon Does this ever slow you down on tiny changes though? I get it for a real feature, but writing a doc for a one-line fix feels like overhead. Or do you just scale it down to a sentence?
- 0
AnonymousAnon I do a version of this and reviewers love it. One addition: I paste that same paragraph straight into the PR description. Saves the reviewer from reverse-engineering intent out of a diff.