Re:Ask HN: What was your most humbling learning moment?
by erhaetherth on Monday June 03, 2024 @02:34AM
(#40559918)
My manager gave me gruff the other day for adding a TODO that I had no intention of ever doing. TODOs are like a get out of jail free card. Don't want to do something the reviewer is likely going to call out? Just add a TODO.
Re:Ask HN: What was your most humbling learning moment?
by eru on Monday June 03, 2024 @04:14AM
(#40560396)
That's why some people insists on having a name with each TODO, and some even want a name and a date.
Re:Ask HN: What was your most humbling learning moment?
by datadrivenangel on Monday June 03, 2024 @08:58AM
(#40562224)
some TODOs are actually WOULDDOs
Re:Ask HN: What was your most humbling learning moment?
by gknoy on Monday June 03, 2024 @01:29PM
(#40565002)
I still find them helpful when the change is outside the cope of the current task. I especially like the ones that include both a reference to a Jira ticket (or similar), and an explanation of why, or any gotchas:
# TODO: (CAFE-1256) Refactor steamed-liquid stuff to support non-dairy options
# We don't currently support non-dairy coffee additives, but once we do
# we will need to ensure that the steamed-liquid transport
# also alerts when users have a dairy allergy.
This is a lot of stuff to add for some things, so we might not want it everywhere, but it helps explain to a reader why we don't currently have it built (product doesn't need X yet), but also has hooks to existing (planned/canceled) tickets and is easily greppable (e.g. "non-dairy" or ticket name).
I became very fond of #TODO ‘s.