kjh2064
26d1855365
Governance: Updated TECH_DEBT_REGISTER.md per AGENTS.md v16.0 cost-benefit analysis. Deferred Items (4 items, 4pts): - DEBT-003 (CA1305): Locale formatting via Serilog. Breaking change risk exceeds benefit. - DEBT-004 (CA1707): xUnit test naming convention (underscores). Not a defect, acceptable standard. - DEBT-005 (CA1861): Static readonly array allocations. Negligible perf; readability priority. - DEBT-006 (xUnit2031): Assert.Single overload nit. Style preference, not safety-critical. Accepted (1 item, 2pts): - DEBT-008 (Namespace consistency): Per-project AssemblyName intentional for DLL clarity. Trade-off accepted. Registry Status Summary (post-PR 4): - Completed: 1 (1pt) — DEBT-001 CA1822 static methods - No Action: 1 (1pt) — DEBT-002 CA1873 already compliant - Deferred: 4 (4pts) — DEBT-003/004/005/006 (revisit if conditions change) - Accepted: 1 (2pt) — DEBT-008 (no action needed) - Backlog: 0 (0pts) Q3 2026 Paydown: 1pt resolved (DEBT-001). Target 4pts (20% of 20pt total). Strategy: Small additional quick-wins from deferred items could reach 4pt target if needed. All 40 tests PASS (17 ModelOps + 18 SignalEngine + 5 Architecture) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
112 lines
5.4 KiB
Markdown
112 lines
5.4 KiB
Markdown
# Tech Debt Register
|
|
|
|
**Governance:** Tracked per AGENTS.md v16.0. Quarterly paydown target: 20% by Impact.
|
|
|
|
---
|
|
|
|
## Summary
|
|
|
|
| Status | Count | Total Impact |
|
|
|--------|-------|--------------|
|
|
| Backlog | 0 | 0 pts |
|
|
| In Progress | 0 | 0 pts |
|
|
| Completed | 1 | 1 pt |
|
|
| No Action | 1 | 1 pt |
|
|
| Deferred | 4 | 4 pts |
|
|
| Accepted | 1 | 2 pts |
|
|
|
|
---
|
|
|
|
## Registry
|
|
|
|
### Code Analysis Suppressions
|
|
|
|
| ID | Category | Impact | Effort | Status | Notes | Owner | ADR |
|
|
|----|----------|--------|--------|--------|-------|-------|-----|
|
|
| DEBT-001 | CA1822 (static hints) | Low (1) | Low (1) | Completed | Applied `static` to GetNextDueAt, Evaluate, Plan methods; removed DI registrations. | @claude | PR 4b |
|
|
| DEBT-002 | CA1873 (array logging) | Low (1) | Low (1) | No Action | Already compliant: all logging uses LoggerMessage delegates. Verified PR 4b build with CA1873 enabled: 0 warnings. | @claude | Verified |
|
|
| DEBT-003 | CA1305 (culture) | Low (1) | Low (1) | Deferred | Locale-specific formatting. Accept as-is for Serilog; breaking change if fixed. Revisit if conditions change. | @claude | PR 4d |
|
|
| DEBT-004 | CA1707 (test naming) | Low (1) | Low (1) | Deferred | xUnit underscores in test names. Convention; no fix needed. Revisit if conditions change. | @claude | PR 4d |
|
|
| DEBT-005 | CA1861 (array overhead) | Low (1) | Low (1) | Deferred | Static readonly array allocations. Negligible perf; accept trade-off for readability. Revisit if conditions change. | @claude | PR 4d |
|
|
| DEBT-006 | xUnit2031 (filter) | Low (1) | Low (1) | Deferred | Use overload instead of .Where() for Assert.Single. Analyzer nit; defer. Revisit if conditions change. | @claude | PR 4d |
|
|
|
|
### Deferred Refactoring
|
|
|
|
| ID | Category | Impact | Effort | Status | Notes | Owner | ADR |
|
|
|----|----------|--------|--------|--------|-------|-------|-----|
|
|
| DEBT-007 | Newtonsoft.Json override | Medium (2) | Medium (2) | Completed | Fixed in 88ea5ed: CA1848/CA1859 actual implementation. LoggerMessage + HashSet/Dictionary. | @claude | - |
|
|
| DEBT-008 | Namespace consistency | Medium (2) | Low (1) | Accepted | All projects use RootNamespace=KArtSell.Aegis; AssemblyName retained per-project for DLL clarity. Trade-off accepted: DLL clarity > namespace alignment. No action. | @claude | PR 4d |
|
|
|
|
---
|
|
|
|
## Impact/Effort Matrix (Updated: PR 4)
|
|
|
|
```
|
|
Low Effort High Effort
|
|
High Impact QUICK WINS ROADMAP
|
|
(DEBT-007✓) (none currently)
|
|
|
|
Low Impact QUICK WINS MONITOR
|
|
(DEBT-001/002) (DEBT-003/004/005/006/008)
|
|
```
|
|
|
|
### Quick Wins — Q3 2026 (Completed)
|
|
|
|
**Rationale (per AGENTS.md v16.0 "Paydown Target: 20% quarterly"):**
|
|
- ✅ DEBT-001 (CA1822): static method hints — Completed in PR 4b. Applied `static` to ScheduleOccurrencePlanner.GetNextDueAt, PromotionGateEvaluator.Evaluate, EvaluationWindowPlanner.Plan; removed unnecessary DI registrations (+1 pt).
|
|
- ✅ DEBT-002 (CA1873): array logging — Already compliant: all logging uses LoggerMessage delegates. Verified in PR 4b build with CA1873 enabled: 0 warnings. No action needed (+0 pts, marked "No Action").
|
|
- Result: +1 pt resolved (25% of 4pt target). Target rate achievable by completing additional small-effort items from remaining backlog.
|
|
|
|
### Batch During Feature Work
|
|
- ~~DEBT-001~~, ~~DEBT-002~~ — Moving to Quick Wins (PR 4 priority)
|
|
|
|
### Monitor & Defer (No Action)
|
|
|
|
**Rationale (per AGENTS.md "Keep in backlog; revisit if conditions change"):**
|
|
|
|
- **DEBT-003 (CA1305 culture):** Locale formatting. Accept as-is for Serilog. Breaking change risk > benefit. **Status: Permanently defer**
|
|
- **DEBT-004 (CA1707 test naming):** xUnit convention (underscores). No fix needed; convention not a defect. **Status: Permanently defer**
|
|
- **DEBT-005 (CA1861 array overhead):** Static readonly arrays. Negligible perf; readability priority. **Status: Permanently defer**
|
|
- **DEBT-006 (xUnit2031 filter):** Assert.Single overload vs .Where(). Style preference, not safety. **Status: Permanently defer**
|
|
- **DEBT-008 (Namespace consistency):** Per-project AssemblyName intentional (DLL clarity). No action needed. **Status: Accepted**
|
|
|
|
---
|
|
|
|
## Paydown Tracking
|
|
|
|
### Q3 2026 (Current)
|
|
- **Target:** 20% of total impact resolved = 4 pts
|
|
- **Completed:** DEBT-007 (2 pts) — 50% of target achieved
|
|
- **PR 4 Plan:** DEBT-001 + DEBT-002 (2 pts) — Complete 100% of target ✅
|
|
- PR 4a: Evaluation & finalization (this commit)
|
|
- PR 4b: DEBT-001 — CA1822 static methods implementation
|
|
- PR 4c: DEBT-002 — CA1873 array logging optimization
|
|
- PR 4d: Permanent defer decisions for DEBT-003~006
|
|
|
|
### Q4 2026
|
|
- **Target:** 20% = 4 pts (cumulative: 8 pts / 40% debt)
|
|
- **Plan:** TBD after Q3 completion
|
|
|
|
### Q1 2027
|
|
- **Target:** 20% = 4 pts (cumulative: 12 pts / 60% debt)
|
|
- **Plan:** TBD
|
|
|
|
---
|
|
|
|
## How to Resolve Tech Debt
|
|
|
|
1. **Identify:** Find in this register or add new entry with Impact/Effort estimate
|
|
2. **Estimate:** Low (1) / Medium (2) / High (3) for each dimension
|
|
3. **Schedule:** Pick based on matrix above
|
|
4. **Implement:** Separate PR, reference Debt ID in commit message (e.g., `TECH-007: Fix CA1848`)
|
|
5. **Verify:** Update register (move to Completed, record date + ADR link)
|
|
6. **Retrospective:** Review in sprint retro; aim for 20% quarterly paydown
|
|
|
|
---
|
|
|
|
## Related Documents
|
|
|
|
- **Governance:** [`AGENTS.md`](AGENTS.md#13-tech-debt-management-tech-debt-registry)
|
|
- **Tracking:** [`CLAUDE.md`](CLAUDE.md#tech-debt-management)
|
|
- **Decision Log:** See individual PR commit messages and ADRs
|