This commit is contained in:
@@ -44,6 +44,7 @@ Each todo is a markdown file with YAML frontmatter and structured sections. Use
|
||||
|
||||
**Required sections:**
|
||||
- **Problem Statement** - What is broken, missing, or needs improvement?
|
||||
- **Assessment (Pressure Test)** - For code review findings: verification results and engineering judgment
|
||||
- **Findings** - Investigation results, root cause, key discoveries
|
||||
- **Proposed Solutions** - Multiple options with pros/cons, effort, risk
|
||||
- **Recommended Action** - Clear plan (filled during triage)
|
||||
@@ -55,6 +56,12 @@ Each todo is a markdown file with YAML frontmatter and structured sections. Use
|
||||
- **Resources** - Links to errors, tests, PRs, documentation
|
||||
- **Notes** - Additional context or decisions
|
||||
|
||||
**Assessment section fields (for code review findings):**
|
||||
- Assessment: Clear & Correct | Unclear | Likely Incorrect | YAGNI
|
||||
- Recommended Action: Fix now | Clarify | Push back | Skip
|
||||
- Verified: Code, Tests, Usage, Prior Decisions (Yes/No with details)
|
||||
- Technical Justification: Why this finding is valid or should be skipped
|
||||
|
||||
**YAML frontmatter fields:**
|
||||
```yaml
|
||||
---
|
||||
|
||||
@@ -19,6 +19,22 @@ What is broken, missing, or needs improvement? Provide clear context about why t
|
||||
- Email service is missing proper error handling for rate-limit scenarios
|
||||
- Documentation doesn't cover the new authentication flow
|
||||
|
||||
## Assessment (Pressure Test)
|
||||
|
||||
*(For findings from code review or automated agents)*
|
||||
|
||||
| Criterion | Result |
|
||||
|-----------|--------|
|
||||
| **Assessment** | Clear & Correct / Unclear / Likely Incorrect / YAGNI |
|
||||
| **Recommended Action** | Fix now / Clarify / Push back / Skip |
|
||||
| **Verified Code?** | Yes/No - [what was checked] |
|
||||
| **Verified Tests?** | Yes/No - [existing coverage] |
|
||||
| **Verified Usage?** | Yes/No - [how code is used] |
|
||||
| **Prior Decisions?** | Yes/No - [any intentional design] |
|
||||
|
||||
**Technical Justification:**
|
||||
[If pushing back or marking YAGNI, provide specific technical reasoning. Reference codebase constraints, requirements, or trade-offs.]
|
||||
|
||||
## Findings
|
||||
|
||||
Investigation results, root cause analysis, and key discoveries.
|
||||
|
||||
Reference in New Issue
Block a user