Code quality
TODO Cleanup: Turn Comments Into Decisions
TODO cleanup turns comments into decisions. A stale TODO can be a useful warning, an abandoned task, a workaround with no owner, or the only note explaining why code looks strange.
The useful output is a TODO cleanup pull request with resolved comments, linked follow-up issues, preserved rationale, and owner decisions. Keep the review concrete: Resolve TODOs into code changes when the action is obvious and low-risk, then make the next action visible to the team that owns the risk. That matters because the cleanup can still go wrong when deleting useful context instead of resolving it.
Key takeaways
- Treat each cleanup candidate as an owned system with dependencies, not anonymous clutter.
- Use one release cycle plus the planning window for any linked migration or incident follow-up before deciding that “quiet” means “unused.”
- Prefer reversible changes first when deleting useful context instead of resolving it is still plausible.
- Leave behind a TODO cleanup pull request with resolved comments, linked follow-up issues, preserved rationale, and owner decisions so the next review starts with context.
- Measure the result as lower spend, lower risk, less operational drag, or clearer ownership.
Classify Comment Intent
Start with one repository or component where TODO, FIXME, HACK, deprecation comments, linked issues, owners, and recent code changes can be reviewed together. The best cleanup scope is small enough that owners can answer quickly but wide enough to include the attachments that make removal risky.
| Field | Why it matters |
|---|---|
| Owner | Cleanup needs a person or team that can accept the decision |
| Current purpose | A short reason to keep the item, written in present tense |
| Last meaningful use | owners, callers, last change, runtime behavior, and deletion confidence |
| Dependency evidence | repository search, tests, logs, deploy history, and owner review |
| Risk if wrong | The outage, data loss, access failure, or rollback gap the review must avoid |
| Next action | Keep, reduce, archive, disable, remove, or investigate |
Do not make the inventory larger than the decision. A short list with owners and evidence beats a perfect spreadsheet that nobody is willing to act on.
TODO Evidence to Keep
The useful question is not “how old is it?” It is “what would break, become harder to recover, or lose accountability if this disappeared?” For TODO cleanup, collect enough evidence to answer that without relying on naming conventions.
| Check | What to look for | Cleanup signal |
|---|---|---|
| Comment intent | Bug, cleanup, migration, performance note, security warning, or design debt | The comment no longer describes a current risk or action |
| Owner and context | Author, CODEOWNERS, linked ticket, blame history, and nearby tests | No current owner can explain the next decision |
| Code reality | Current behavior, feature flags, replacement code, tests, and production logs | The TODO describes work already done or no longer needed |
| Decision path | Pull request, issue, architecture note, test, or doc location | The useful context can move somewhere actionable |
Use several signals together. Activity can miss monthly jobs and incident-only paths. Ownership can be stale. Cost can distract from security or recovery risk. The strongest case combines runtime data, dependency checks, owner review, and a rollback plan.
If the evidence conflicts, label the item “investigate” with a named owner and review date. That is still progress because the next review starts with a narrower question.
Example Evidence Check
Find stale comments with enough surrounding context to decide whether to resolve, ticket, document, or delete.
rg -n -C 2 "TODO|FIXME|HACK|XXX|deprecated" src tests docs
rg "TODO.*20[0-9]{2}|FIXME.*#[0-9]+|cleanup" src tests
git log --oneline -S "${TODO_TEXT}" -- src
Treat the output as a candidate list. Do not pipe these checks into delete commands; add owner review, dependency checks, and a rollback path first.
Resolve or Move the Decision
Use the least permanent move that proves the decision. In TODO cleanup, removal is only one possible outcome; reducing size, narrowing permission, shortening retention, archiving, or disabling a trigger may produce the same benefit with less risk.
- Resolve TODOs into code changes when the action is obvious and low-risk.
- Move still-valid decisions into tracked issues or docs with an owner and review date.
- Delete comments that only preserve stale anxiety after the code and owner review agree.
Track the cleanup candidate with a simple priority score:
| Score | Good sign | Bad sign |
|---|---|---|
| Impact | Meaningful spend, risk, toil, noise, or confusion disappears | The item is cheap and low-risk but politically distracting |
| Confidence | Owner, purpose, and dependency path are understood | The team is guessing from age or name |
| Reversibility | Restore, recreate, re-enable, or rollback path exists | Deletion would be the first real test |
| Prevention | A rule can stop recurrence | The same pattern will return next month |
Start with high-impact, high-confidence, reversible candidates. Defer confusing items only if they get an owner and a date; otherwise “defer” becomes another word for keeping waste permanently.
Comments That Explain Risk
Some cleanup candidates are supposed to look quiet. Do not rush these cases:
- Security warnings, data-loss caveats, migration notes, and compatibility comments.
- Comments that explain surprising code where no test captures the reason.
- TODOs linked to customer commitments, incidents, or pending platform upgrades.
For these cases, use a longer observation window, explicit owner approval, and a staged reduction. The point is not to avoid cleanup; it is to avoid making the first proof of dependency an outage.
Run the TODO Cleanup PR
Run TODO cleanup as a decision review, not an open-ended hygiene project.
- Pick the narrow scope and export the candidate list.
- Add owner, current purpose, last-use evidence, dependency checks, and risk if wrong.
- Remove obvious false positives, then ask owners to choose keep, reduce, archive, disable, remove, or investigate.
- Apply the least permanent useful change first.
- Watch the signals that would reveal a bad decision.
- Complete the final removal only after the review window closes.
- Save a TODO cleanup pull request with resolved comments, linked follow-up issues, preserved rationale, and owner decisions.
For broader cleanup planning, use the cleanup library to pair this guide with related notes. If the cleanup has infrastructure impact, pair it with a visible owner, a rollback path, and a measurable business case. For infrastructure cleanup, the main cloud cost optimization checklist is a useful companion.
Require Actionable Comments
Prevention should change the creation path, not just the cleanup path. For TODO cleanup, the useful prevention fields are owner, reason to exist, removal trigger, and verification notes. Make those fields part of normal creation and review.
- Require new TODOs to include owner, date, and the decision needed.
- Fail or report comments that use TODO/FIXME without a tracking link in long-lived code.
- Review TODOs as part of feature cleanup and deprecation work.
The recurring review should be short: sort by impact, pick the unclear items, assign owners, and close the loop on anything nobody claims. If the review keeps producing the same class of candidate, fix the creation path instead of celebrating repeated cleanup.
Example Decision Record
Use a compact record so the cleanup can be reviewed later without reconstructing the whole investigation.
| Field | Example entry for this cleanup |
|---|---|
| Candidate | Stale TODO comments in codebases |
| Why it looked stale | Low recent activity, unclear owner, or no current consumer after the first review |
| Evidence checked | Comment intent, Owner and context, and owner confirmation |
| First reversible move | Resolve TODOs into code changes when the action is obvious and low-risk |
| Watch signal | The metric, alert, job, route, query, or owner complaint that would show the cleanup was wrong |
| Final action | Keep, reduce, archive, disable, or remove after one release cycle plus the planning window for any linked migration or incident follow-up |
| Prevention rule | Require new TODOs to include owner, date, and the decision needed |
This record is intentionally small. If the decision needs a long narrative, the candidate is probably not ready for removal yet. Keep investigating until the owner, evidence, reversible move, and prevention rule are clear.
FAQ
How often should teams do TODO cleanup?
Use one release cycle plus the planning window for any linked migration or incident follow-up for the first decision, then set a recurring cadence based on change rate. Fast-moving non-production systems may need monthly review; slower systems can be quarterly if every unclear item has an owner and a review date.
What is the safest first action?
The safest first action is usually ownership repair plus evidence collection. After that, resolve todos into code changes when the action is obvious and low-risk. That creates a visible test before permanent deletion.
What should not be removed quickly?
Do not rush anything connected to security warnings, data-loss caveats, migration notes, and compatibility comments. Also slow down when the cleanup affects recovery, compliance, customer-specific behavior, rare schedules, or security response.
How do you make the decision useful later?
Write the decision as a small operational record: candidate, owner, evidence, chosen action, watch signals, rollback path, final date, and prevention rule. That format helps future engineers, search engines, and AI assistants understand the cleanup without guessing.