2 ms·
Recently we've come to the same conclusion with my team. With one small distinction, we prefix all comments with tags [nit] : i would do this differently (opin
by simplyinfinity 7y ago
Recently we've come to the same conclusion with my team. With one small distinction, we prefix all comments with tags
[nit] : i would do this differently (opinion based) (for vs foeach for example )
[tip] : for future reference you can do this in x or y way, or you can use foo framework/language feature, but your way is OK to
[blocker] : possible bug,performance,security business logic issues
[Q(uestion)]: what is the reasoning behind this code ( could also indicate need for documentation)
the nit & tip ones we don't force anyone to fix or even address, but all questions and blockers must be answered & resolved.
- Klathmon 7y agoI've also adopted almost exactly this in all code review comments anywhere. I try to make my intentions of the comment explicit, saying things like "this is a minor nitpick, but..." or "as a tip for future changes, this can be done like..."