claude-engineering-plugin/plugins/compounding-engineering/skills/file-todos/assets/todo-template.md

status, priority, issue_id, tags, dependencies

status	priority	issue_id	tags	dependencies
pending	p2	XXX

Brief Task Title

Replace with a concise title describing what needs to be done.

Problem Statement

What is broken, missing, or needs improvement? Provide clear context about why this matters.

Example:

• Template system lacks comprehensive test coverage for edge cases discovered during PR review
• Email service is missing proper error handling for rate-limit scenarios
• Documentation doesn't cover the new authentication flow

Findings

Investigation results, root cause analysis, and key discoveries.

• Finding 1 (with specifics: file, line number if applicable)
• Finding 2
• Key discovery with impact assessment
• Related issues or patterns discovered

Example format:

• Identified 12 missing test scenarios in app/models/user_test.rb
• Current coverage: 60% of code paths
• Missing: empty inputs, special characters, large payloads
• Similar issues exist in app/models/post_test.rb (~8 scenarios)

Proposed Solutions

Present multiple options with pros, cons, effort estimates, and risk assessment.

Option 1: [Solution Name]

Approach: Describe the solution clearly.

Pros:

• Benefit 1
• Benefit 2

Cons:

• Drawback 1
• Drawback 2

Effort: 2-3 hours

Risk: Low / Medium / High

---

Option 2: [Solution Name]

Approach: Describe the solution clearly.

Pros:

• Benefit 1
• Benefit 2

Cons:

• Drawback 1
• Drawback 2

Effort: 4-6 hours

Risk: Low / Medium / High

---

Option 3: [Solution Name]

(Include if you have alternatives)

Recommended Action

To be filled during triage. Clear, actionable plan for resolving this todo.

Example: "Implement both unit tests (covering each scenario) and integration tests (full pipeline) before merging. Estimated 4 hours total effort. Target coverage > 85% for this module."

Technical Details

Affected files, related components, database changes, or architectural considerations.

Affected files:

• app/models/user.rb:45 - full_name method
• app/services/user_service.rb:12 - validation logic
• test/models/user_test.rb - existing tests

Related components:

• UserMailer (depends on user validation)
• AccountPolicy (authorization checks)

Database changes (if any):

• Migration needed? Yes / No
• New columns/tables? Describe here

Resources

Links to errors, tests, PRs, documentation, similar issues.

• PR: #1287
• Related issue: #456
• Error log: [link to AppSignal incident]
• Documentation: [relevant docs]
• Similar patterns: Issue #200 (completed, ref for approach)

Acceptance Criteria

Testable checklist items for verifying completion.

• All acceptance criteria checked
• Tests pass (unit + integration if applicable)
• Code reviewed and approved
• (Example) Test coverage > 85%
• (Example) Performance metrics acceptable
• (Example) Documentation updated

Work Log

Chronological record of work sessions, actions taken, and learnings.

2025-11-12 - Initial Discovery

By: Claude Code

Actions:

• Identified 12 missing test scenarios
• Analyzed existing test coverage (file:line references)
• Reviewed similar patterns in codebase
• Drafted 3 solution approaches

Learnings:

• Similar issues exist in related modules
• Current test setup supports both unit and integration tests
• Performance testing would be valuable addition

---

(Add more entries as work progresses)

Notes

Additional context, decisions, or reminders.

• Decision: Include both unit and integration tests for comprehensive coverage
• Blocker: Depends on completion of issue #001
• Timeline: Priority for sprint due to blocking other work