Skip to content

tech-debt: Address 52 TODO/FIXME/HACK/BUG comments across codebase #75

@mrveiss

Description

@mrveiss

Summary

Technical debt audit identified 52 TODO/FIXME/HACK/BUG comments across 22 files in the src/ directory. These represent known issues, incomplete implementations, or areas requiring attention.

Breakdown by File

High Priority (Core Infrastructure):

  • src/config.py - 4 items
  • src/chat_history_manager.py - 2 items
  • src/llm_self_awareness.py - 2 items

Active Development Files:

  • src/agents/development_speedup_agent.py - 4 items
  • src/memory_manager.py - 1 item
  • src/chat_workflow_manager.py - 1 item
  • src/npu_semantic_search.py - 1 item
  • src/llm_interface.py - likely more
  • src/langchain_agent_orchestrator.py - 1 item

Archived/Legacy (Lower Priority):

  • src/archive/orphaned_chat_consolidations_2025-01-14/simple_chat_workflow.py - 21 items
  • src/archive/consolidated_chat_workflows/chat_workflow_manager.py - 1 item

Categories of Technical Debt

  1. Incomplete Features - Partially implemented functionality
  2. Known Bugs - Documented bugs awaiting fixes
  3. Performance Hacks - Temporary workarounds
  4. Security TODOs - Security improvements needed
  5. Refactoring Markers - Code that needs cleanup

Action Plan

Phase 1: Audit (2-4 hours)

  • Extract all TODO/FIXME comments with context
  • Categorize by severity (critical, high, medium, low)
  • Identify quick wins vs. major refactoring
  • Create sub-issues for critical items

Phase 2: Quick Wins (4-8 hours)

  • Fix all simple TODOs (< 30 min each)
  • Remove outdated/irrelevant TODOs
  • Convert important TODOs to GitHub issues

Phase 3: Major Items (ongoing)

  • Create individual issues for complex items
  • Schedule major refactoring work
  • Track resolution progress

Acceptance Criteria

  • All TODOs audited and categorized
  • Critical TODOs fixed or have dedicated issues
  • Archived code excluded from active count
  • TODO count reduced by 50% (26 or fewer)
  • No new TODOs added without justification
  • Pre-commit hook to track TODO growth

Automated Detection Script

# Count TODOs by file
grep -r "TODO\|FIXME\|HACK\|XXX\|BUG" src/ --include="*.py" | \
  grep -v "archive/" | \
  cut -d: -f1 | sort | uniq -c | sort -rn

Benefits

  • Code Quality - Cleaner, more maintainable codebase
  • Technical Debt Visibility - Track debt reduction
  • Developer Onboarding - Fewer confusing TODOs
  • Production Readiness - No hidden issues
  • Compliance - CLAUDE.md "No Temporary Fixes" policy enforcement

Priority

Medium - Technical debt reduction for long-term maintainability

Estimated Effort

  • Audit: 2-4 hours
  • Quick wins: 4-8 hours
  • Major items: Create separate issues

Related

  • CLAUDE.md "No Temporary Fixes" policy
  • Code quality enforcement
  • Pre-commit hooks

Note: This violates the CLAUDE.md rule "Never use TODOs" - each TODO should either be fixed immediately or converted to a GitHub issue with proper tracking.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions