2 ms·
At some point convention at Google on many teams I was on switched from: TODO(username): blah blah to almost-mandatory: TOOD(bug#): blah blah. Gonna write a
by cmrdporcupine 5y ago
At some point convention at Google on many teams I was on switched from:
TODO(username): blah blah
to almost-mandatory:
TOOD(bug#): blah blah.
Gonna write a TODO? Make a ticket for it, and follow up
- marginalia_nu 5y agoI've really liked using a template that looks like this: // TODO ${username} $[date} (ISSUE) - message Having a who and a when is very useful for quickly determining what it's about. The username is helpful for myself for quickly finding my own TODOs, the date is useful for others, as if the issue is so small nobody has bothered fixing it for years, then odds are it's probably not ever going to get fixed and then the TODO can probably be removed.
- erdaniels 5y agobeen using this approach for a while. it also comes up in PRs to encourage either fixing the issue now, realizing it doesn't need the TODO, or saving it for later. and +1 on searchability when searching ISSUE-XXX and seeing all relevant comments. Would make for a good tool