Skip to content

Add issue to TODO comments in code base #2026

@nbuncicTT

Description

@nbuncicTT

Description

Audit and remediate all TODO comments in the tt-umd codebase to ensure explicit tracking of technical debt.

Current State (LLM generated - take with a grain of salt):

  • Total TODO comments: 283
  • TODOs with issue tracking: 7 (2.5%)
  • TODOs without tracking: 276 (97.5%)
  • Repository age: ~2 years (January 2024 - February 2026)
  • TODO age range: 2 months to 14 months
    • Oldest sampled: October 2024 (~14 months old)
    • Recent: December 2025 (~2 months old)
    • Average age estimate: 6-8 months

Problem

The vast majority of TODOs lack issue tracking, making it difficult to:

  • Prioritize technical debt
  • Track completion over time
  • Understand context and ownership
  • Prevent TODOs from becoming stale

Proposed Solution

For each of the 283 TODO comments, either:

  • Create a GitHub issue and update the TODO to reference it: TODO(#issue-num):
  • Implement the fix immediately if trivial
  • Remove the TODO if obsolete or no longer applicable

Definition of Done (DoD):

  • All 283 TODO comments are audited
  • Each remaining TODO has a GitHub issue reference in format TODO(#issue-num):
  • Obsolete TODOs are removed
  • Trivial TODOs are fixed and removed
  • CI check or policy established requiring issue references for new TODOs (i.e. if somebody adds a TODO without an issue this should trigger some checks)
  • Documentation updated with TODO policy

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions