codex-genesis-harness 0.1.1 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.codebase/ARCHITECTURE_REVIEW_COMPLETE.md +216 -0
- package/.codebase/CURRENT_STATE.md +2 -0
- package/.codebase/DOMAIN_MODELS.md +5 -3
- package/.codebase/FILE_NAMING_CLARIFICATION.md +161 -0
- package/.codebase/HARNESS_COMPLETENESS_AUDIT.md +613 -0
- package/.codebase/IMPLEMENTATION_COMPLETE.md +429 -0
- package/.codebase/IMPLEMENTATION_HANDOFF.md +351 -0
- package/.codebase/IMPROVEMENTS_SUMMARY.md +419 -0
- package/.codebase/PHASE3_SKILLS_NAMING_COMPLETE.md +292 -0
- package/.codebase/PHASE_DEPENDENCY_MAP.md +486 -0
- package/.codebase/QUICK_START_SPEC_IMPACT.md +456 -0
- package/.codebase/README.md +139 -0
- package/.codebase/RECOVERY_POINTS.md +438 -0
- package/.codex/skills/genesis-api-sync/SKILL.md +354 -0
- package/.codex/skills/genesis-api-sync/agents/openai.yaml +7 -0
- package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -0
- package/.codex/skills/genesis-api-sync/examples/example.md +68 -0
- package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -0
- package/.codex/skills/genesis-debug-guide/SKILL.md +479 -0
- package/.codex/skills/genesis-debug-guide/agents/openai.yaml +7 -0
- package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -0
- package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -0
- package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -0
- package/.codex/skills/genesis-debug-guide/examples/example.md +48 -0
- package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -0
- package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -0
- package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -0
- package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -0
- package/.codex/skills/genesis-docs-automation/agents/openai.yaml +7 -0
- package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -0
- package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -0
- package/.codex/skills/genesis-docs-automation/examples/example.md +59 -0
- package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -0
- package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -0
- package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -0
- package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -0
- package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -0
- package/.codex/skills/genesis-harness/SKILL.md +734 -82
- package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -0
- package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -0
- package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -0
- package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -0
- package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -0
- package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -0
- package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -0
- package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -0
- package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +23 -23
- package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +24 -24
- package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +21 -21
- package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +46 -46
- package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +24 -24
- package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +25 -25
- package/.codex/skills/genesis-harness/scripts/compact-context.sh +54 -0
- package/.codex/skills/genesis-harness/scripts/create-adr.sh +74 -74
- package/.codex/skills/genesis-harness/scripts/create-bug.sh +160 -160
- package/.codex/skills/genesis-harness/scripts/create-feature.sh +217 -217
- package/.codex/skills/genesis-harness/scripts/detect-stack.sh +26 -26
- package/.codex/skills/genesis-harness/scripts/init-planning.sh +750 -719
- package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +12 -12
- package/.codex/skills/genesis-harness/scripts/offload-log.sh +72 -0
- package/.codex/skills/genesis-harness/scripts/run-verification.sh +47 -47
- package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +75 -0
- package/.codex/skills/genesis-harness/scripts/update-state.sh +33 -33
- package/.codex/skills/genesis-harness-engineering/SKILL.md +159 -0
- package/.codex/skills/genesis-harness-engineering/checklists/checklist.md +48 -0
- package/.codex/skills/genesis-harness-engineering/examples/example.md +57 -0
- package/.codex/skills/genesis-harness-engineering/playbooks/harness-evolution.md +99 -0
- package/.codex/skills/genesis-harness-engineering/templates/harness-change-template.md +37 -0
- package/.codex/skills/genesis-observability-automation/SKILL.md +382 -0
- package/.codex/skills/genesis-observability-automation/agents/openai.yaml +7 -0
- package/.codex/skills/genesis-observability-automation/examples/example.md +86 -0
- package/.codex/skills/genesis-performance-profiling/SKILL.md +510 -0
- package/.codex/skills/genesis-performance-profiling/agents/openai.yaml +6 -0
- package/.codex/skills/genesis-performance-profiling/checklists/optimization-verification.md +199 -0
- package/.codex/skills/genesis-performance-profiling/checklists/performance-baseline.md +183 -0
- package/.codex/skills/genesis-performance-profiling/examples/example.md +234 -0
- package/.codex/skills/genesis-performance-profiling/observability/performance-tracking.md +202 -0
- package/.codex/skills/genesis-performance-profiling/playbooks/load-testing-orchestration.md +593 -0
- package/.codex/skills/genesis-performance-profiling/playbooks/profiling-playbook.md +601 -0
- package/.codex/skills/genesis-performance-profiling/templates/load-test-config-template.md +428 -0
- package/.codex/skills/genesis-performance-profiling/templates/performance-report-template.md +238 -0
- package/.codex/skills/genesis-release-orchestration/SKILL.md +653 -0
- package/.codex/skills/genesis-release-orchestration/agents/openai.yaml +7 -0
- package/.codex/skills/genesis-release-orchestration/checklists/post-deployment-verification.md +274 -0
- package/.codex/skills/genesis-release-orchestration/checklists/pre-release-validation.md +220 -0
- package/.codex/skills/genesis-release-orchestration/examples/example.md +78 -0
- package/.codex/skills/genesis-release-orchestration/observability/release-tracking.md +253 -0
- package/.codex/skills/genesis-release-orchestration/playbooks/canary-deployment-orchestration.md +472 -0
- package/.codex/skills/genesis-release-orchestration/playbooks/semantic-versioning-automation.md +494 -0
- package/.codex/skills/genesis-release-orchestration/templates/deployment-strategy-template.md +303 -0
- package/.codex/skills/genesis-release-orchestration/templates/release-runbook-template.md +420 -0
- package/.codex/skills/genesis-research-first/SKILL.md +237 -0
- package/.codex/skills/genesis-research-first/agents/openai.yaml +7 -0
- package/.codex/skills/genesis-research-first/examples/example.md +85 -0
- package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -0
- package/.codex/skills/genesis-spec-propagation/agents/openai.yaml +7 -0
- package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -0
- package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -0
- package/.codex/skills/genesis-spec-propagation/examples/example.md +63 -0
- package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -0
- package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -0
- package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -0
- package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -0
- package/.codex/skills/spec-impact-engine/SKILL.md +504 -0
- package/.codex/skills/spec-impact-engine/agents/openai.yaml +7 -0
- package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +262 -0
- package/.codex/skills/spec-impact-engine/examples/example.md +98 -0
- package/.codex/skills/spec-impact-engine/templates/impact-report.md +248 -0
- package/.codex/skills/spec-impact-engine/templates/migration-guide.md +223 -0
- package/.codex-plugin/plugin.json +1 -1
- package/README.EN.md +719 -0
- package/README.VI.md +712 -0
- package/README.md +261 -107
- package/VERSION +1 -1
- package/bin/genesis-harness.js +20 -11
- package/package.json +1 -1
- package/scripts/README.md +342 -0
- package/scripts/compact-context.sh +54 -0
- package/scripts/detect-changes.sh +152 -0
- package/scripts/install.sh +50 -41
- package/scripts/offload-log.sh +72 -0
- package/scripts/run-evals.sh +70 -43
- package/scripts/run-verify-loop.sh +75 -0
- package/scripts/uninstall.sh +52 -43
- package/scripts/verify.sh +165 -73
- package/.codex/skills/harness-engineering-skill/SKILL.md +0 -45
- package/.codex/skills/harness-engineering-skill/checklists/checklist.md +0 -8
- package/.codex/skills/harness-engineering-skill/examples/example.md +0 -4
- package/.codex/skills/harness-engineering-skill/templates/harness-change-template.md +0 -8
- /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/SKILL.md +0 -0
- /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/agents/openai.yaml +0 -0
- /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/checklists/checklist.md +0 -0
- /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/examples/example.md +0 -0
- /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/templates/provider-contract-template.md +0 -0
- /package/.codex/skills/{api-contract-skill → genesis-api-contract}/SKILL.md +0 -0
- /package/.codex/skills/{api-contract-skill → genesis-api-contract}/agents/openai.yaml +0 -0
- /package/.codex/skills/{api-contract-skill → genesis-api-contract}/checklists/checklist.md +0 -0
- /package/.codex/skills/{api-contract-skill → genesis-api-contract}/examples/example.md +0 -0
- /package/.codex/skills/{api-contract-skill → genesis-api-contract}/templates/api-contract-template.md +0 -0
- /package/.codex/skills/{architecture-skill → genesis-architecture}/SKILL.md +0 -0
- /package/.codex/skills/{architecture-skill → genesis-architecture}/agents/openai.yaml +0 -0
- /package/.codex/skills/{architecture-skill → genesis-architecture}/checklists/checklist.md +0 -0
- /package/.codex/skills/{architecture-skill → genesis-architecture}/examples/example.md +0 -0
- /package/.codex/skills/{architecture-skill → genesis-architecture}/templates/architecture-decision-template.md +0 -0
- /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/SKILL.md +0 -0
- /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/agents/openai.yaml +0 -0
- /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/checklists/checklist.md +0 -0
- /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/examples/example.md +0 -0
- /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/templates/map-update-template.md +0 -0
- /package/.codex/skills/{design-spec-skill → genesis-design-spec}/SKILL.md +0 -0
- /package/.codex/skills/{design-spec-skill → genesis-design-spec}/agents/openai.yaml +0 -0
- /package/.codex/skills/{design-spec-skill → genesis-design-spec}/checklists/checklist.md +0 -0
- /package/.codex/skills/{design-spec-skill → genesis-design-spec}/examples/example.md +0 -0
- /package/.codex/skills/{design-spec-skill → genesis-design-spec}/templates/design-spec-template.md +0 -0
- /package/.codex/skills/{docs-skill → genesis-docs}/SKILL.md +0 -0
- /package/.codex/skills/{docs-skill → genesis-docs}/agents/openai.yaml +0 -0
- /package/.codex/skills/{docs-skill → genesis-docs}/checklists/checklist.md +0 -0
- /package/.codex/skills/{docs-skill → genesis-docs}/examples/example.md +0 -0
- /package/.codex/skills/{docs-skill → genesis-docs}/templates/docs-update-template.md +0 -0
- /package/.codex/skills/{harness-engineering-skill → genesis-harness-engineering}/agents/openai.yaml +0 -0
- /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/SKILL.md +0 -0
- /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/agents/openai.yaml +0 -0
- /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/checklists/checklist.md +0 -0
- /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/examples/example.md +0 -0
- /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/templates/orchestration-template.md +0 -0
- /package/.codex/skills/{planning-skill → genesis-planning}/SKILL.md +0 -0
- /package/.codex/skills/{planning-skill → genesis-planning}/agents/openai.yaml +0 -0
- /package/.codex/skills/{planning-skill → genesis-planning}/checklists/checklist.md +0 -0
- /package/.codex/skills/{planning-skill → genesis-planning}/examples/example.md +0 -0
- /package/.codex/skills/{planning-skill → genesis-planning}/templates/plan-template.md +0 -0
- /package/.codex/skills/{release-skill → genesis-release}/SKILL.md +0 -0
- /package/.codex/skills/{release-skill → genesis-release}/agents/openai.yaml +0 -0
- /package/.codex/skills/{release-skill → genesis-release}/checklists/checklist.md +0 -0
- /package/.codex/skills/{release-skill → genesis-release}/examples/example.md +0 -0
- /package/.codex/skills/{release-skill → genesis-release}/templates/release-checklist-template.md +0 -0
- /package/.codex/skills/{research-skill → genesis-research}/SKILL.md +0 -0
- /package/.codex/skills/{research-skill → genesis-research}/agents/openai.yaml +0 -0
- /package/.codex/skills/{research-skill → genesis-research}/checklists/checklist.md +0 -0
- /package/.codex/skills/{research-skill → genesis-research}/examples/example.md +0 -0
- /package/.codex/skills/{research-skill → genesis-research}/templates/research-note-template.md +0 -0
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Bug Fix Q&A Checklist
|
|
2
|
+
|
|
3
|
+
**Purpose**: Structured questionnaire to understand and document bug fixes before planning /fix-bug.
|
|
4
|
+
|
|
5
|
+
**Status**: MANDATORY - Complete before creating implementation plan.
|
|
6
|
+
|
|
7
|
+
## Bug Identification & Reproduction
|
|
8
|
+
|
|
9
|
+
- [ ] **Bug clearly described**:
|
|
10
|
+
- What is the incorrect behavior?
|
|
11
|
+
- What should happen instead?
|
|
12
|
+
- Step-by-step repro steps documented
|
|
13
|
+
|
|
14
|
+
- [ ] **Reproducibility confirmed**:
|
|
15
|
+
- Consistently reproducible?
|
|
16
|
+
- Specific conditions/environment needed?
|
|
17
|
+
- Affects all users or specific scenarios?
|
|
18
|
+
|
|
19
|
+
- [ ] **Severity & Priority assessed**:
|
|
20
|
+
- Critical (blocks core functionality)?
|
|
21
|
+
- High (significant impact, workaround exists)?
|
|
22
|
+
- Medium (inconvenience, non-blocking)?
|
|
23
|
+
- Low (cosmetic, nice-to-fix)?
|
|
24
|
+
|
|
25
|
+
- [ ] **Affected Versions identified**:
|
|
26
|
+
- When was this introduced?
|
|
27
|
+
- Which versions affected?
|
|
28
|
+
- Latest stable version affected?
|
|
29
|
+
|
|
30
|
+
## Root Cause Analysis
|
|
31
|
+
|
|
32
|
+
- [ ] **Root cause identified** (or hypothesis if unknown):
|
|
33
|
+
- Specific code location/module?
|
|
34
|
+
- Logic error or incorrect assumption?
|
|
35
|
+
- Missing validation or error handling?
|
|
36
|
+
- Race condition or state issue?
|
|
37
|
+
- Integration bug with external service?
|
|
38
|
+
|
|
39
|
+
- [ ] **Why was it missed**:
|
|
40
|
+
- Was there a test that should have caught this?
|
|
41
|
+
- Missing test coverage?
|
|
42
|
+
- Environment-specific (dev vs. production)?
|
|
43
|
+
|
|
44
|
+
- [ ] **Affected systems mapped**:
|
|
45
|
+
- Single module or cross-module issue?
|
|
46
|
+
- API side or client side?
|
|
47
|
+
- Database or state management?
|
|
48
|
+
- Performance or correctness?
|
|
49
|
+
|
|
50
|
+
## Impact Assessment
|
|
51
|
+
|
|
52
|
+
- [ ] **Data Integrity concerns**:
|
|
53
|
+
- Has data been corrupted or lost?
|
|
54
|
+
- Rollback/recovery strategy needed?
|
|
55
|
+
- Data migration required after fix?
|
|
56
|
+
|
|
57
|
+
- [ ] **User Impact**:
|
|
58
|
+
- How many users affected?
|
|
59
|
+
- What functionality is broken?
|
|
60
|
+
- Workaround available in the meantime?
|
|
61
|
+
|
|
62
|
+
- [ ] **Breaking Change Risk**:
|
|
63
|
+
- Does the fix change public API behavior?
|
|
64
|
+
- Will this break existing clients?
|
|
65
|
+
- Backward compatibility needed?
|
|
66
|
+
|
|
67
|
+
## Fix Strategy
|
|
68
|
+
|
|
69
|
+
- [ ] **Fix approach decided**:
|
|
70
|
+
- Minimal change to fix only the bug?
|
|
71
|
+
- Or refactor to prevent similar bugs?
|
|
72
|
+
- Tradeoffs understood?
|
|
73
|
+
|
|
74
|
+
- [ ] **Side Effects considered**:
|
|
75
|
+
- What other code paths use this?
|
|
76
|
+
- Could this fix introduce new bugs?
|
|
77
|
+
- Dependencies to check?
|
|
78
|
+
|
|
79
|
+
- [ ] **Regression Prevention**:
|
|
80
|
+
- What test catches this bug?
|
|
81
|
+
- Test added before or after fix?
|
|
82
|
+
- Similar patterns to look for?
|
|
83
|
+
|
|
84
|
+
## Testing & Verification
|
|
85
|
+
|
|
86
|
+
- [ ] **Test Case for Bug**:
|
|
87
|
+
- Failing test created before fix?
|
|
88
|
+
- Test reproduces the exact bug?
|
|
89
|
+
- Test passes after fix?
|
|
90
|
+
|
|
91
|
+
- [ ] **Regression Tests**:
|
|
92
|
+
- Existing tests still pass?
|
|
93
|
+
- Edge cases covered?
|
|
94
|
+
- Similar bugs tested in other areas?
|
|
95
|
+
|
|
96
|
+
- [ ] **Verification Plan**:
|
|
97
|
+
- How will we verify fix in production?
|
|
98
|
+
- Monitoring/alerts to confirm success?
|
|
99
|
+
- Rollback plan if fix causes issues?
|
|
100
|
+
|
|
101
|
+
## Deployment & Release
|
|
102
|
+
|
|
103
|
+
- [ ] **Hotfix or Regular Release**:
|
|
104
|
+
- Needs immediate hotfix deployment?
|
|
105
|
+
- Can wait for next regular release?
|
|
106
|
+
- Affects which release branches?
|
|
107
|
+
|
|
108
|
+
- [ ] **Release Notes**:
|
|
109
|
+
- What message for end users?
|
|
110
|
+
- Migration steps if needed?
|
|
111
|
+
- Workaround guidance during transition?
|
|
112
|
+
|
|
113
|
+
- [ ] **Rollout Strategy**:
|
|
114
|
+
- Staged rollout or immediate?
|
|
115
|
+
- Feature flags needed?
|
|
116
|
+
- Canary deployment approach?
|
|
117
|
+
|
|
118
|
+
## Documentation Updates
|
|
119
|
+
|
|
120
|
+
- [ ] **Docs need updating**:
|
|
121
|
+
- Behavior changed in docs?
|
|
122
|
+
- Workaround documented?
|
|
123
|
+
- Migration guide needed?
|
|
124
|
+
|
|
125
|
+
- [ ] **Release Notes written**:
|
|
126
|
+
- User-friendly description
|
|
127
|
+
- Workaround mentioned if applicable
|
|
128
|
+
- Any breaking changes noted
|
|
129
|
+
|
|
130
|
+
## Lesson Learned
|
|
131
|
+
|
|
132
|
+
- [ ] **How to prevent this in future**:
|
|
133
|
+
- Better test coverage?
|
|
134
|
+
- Code review checklist item?
|
|
135
|
+
- Documentation gap?
|
|
136
|
+
- Process improvement?
|
|
137
|
+
|
|
138
|
+
- [ ] **Similar bugs searched**:
|
|
139
|
+
- Pattern scan for similar issues in codebase?
|
|
140
|
+
- Found and fixed other instances?
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Usage
|
|
145
|
+
|
|
146
|
+
Use this checklist **before** calling `/fix-bug`:
|
|
147
|
+
|
|
148
|
+
```
|
|
149
|
+
1. Read and reproduce the bug
|
|
150
|
+
2. Complete this checklist thoroughly
|
|
151
|
+
3. Add bug details to implementation plan
|
|
152
|
+
4. Create failing test first
|
|
153
|
+
5. Fix with minimal change
|
|
154
|
+
6. Verify all tests pass
|
|
155
|
+
7. Document lesson learned
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
## Known Information About Bug
|
|
159
|
+
|
|
160
|
+
- **Bug ID/Ticket**: _reference_
|
|
161
|
+
- **Reported By**: _name_
|
|
162
|
+
- **Date Reported**: _YYYY-MM-DD_
|
|
163
|
+
- **Current Status**: _New / Assigned / In Progress_
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
**Checklist Completed**: ☐
|
|
168
|
+
**Date**: _YYYY-MM-DD_
|
|
169
|
+
**Assigned To**: _Name_
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
# New Feature Q&A Checklist
|
|
2
|
+
|
|
3
|
+
**Purpose**: Structured questionnaire to capture all requirements before planning /new-feature.
|
|
4
|
+
|
|
5
|
+
**Status**: MANDATORY - Complete all fields before /plan is created.
|
|
6
|
+
|
|
7
|
+
## User Story & Intent
|
|
8
|
+
|
|
9
|
+
- [ ] **User Story defined**: "As a [who], I want [what] so that [why]"
|
|
10
|
+
- Who is the primary user/actor?
|
|
11
|
+
- What specific action or capability do they need?
|
|
12
|
+
- What outcome or value does this deliver?
|
|
13
|
+
|
|
14
|
+
- [ ] **Success Criteria clear**: How do we know this feature is working?
|
|
15
|
+
- At least 3 measurable criteria
|
|
16
|
+
- Business metrics or user satisfaction indicators
|
|
17
|
+
|
|
18
|
+
- [ ] **Out of Scope documented**: What is explicitly NOT included?
|
|
19
|
+
- Related features we're NOT doing now
|
|
20
|
+
- Future enhancements or phases
|
|
21
|
+
|
|
22
|
+
## Requirements & Constraints
|
|
23
|
+
|
|
24
|
+
- [ ] **Functional Requirements clear**:
|
|
25
|
+
- Primary use cases (happy path)
|
|
26
|
+
- Secondary use cases
|
|
27
|
+
- Data inputs and outputs
|
|
28
|
+
|
|
29
|
+
- [ ] **Non-Functional Requirements identified**:
|
|
30
|
+
- Performance expectations (speed, throughput, latency)
|
|
31
|
+
- Scalability requirements
|
|
32
|
+
- Availability/uptime requirements
|
|
33
|
+
- Browser/device support
|
|
34
|
+
|
|
35
|
+
- [ ] **Dependencies & Integrations mapped**:
|
|
36
|
+
- Does this touch APIs? Which ones?
|
|
37
|
+
- Database schema changes needed?
|
|
38
|
+
- External services involved?
|
|
39
|
+
- Existing modules that will be modified?
|
|
40
|
+
|
|
41
|
+
- [ ] **Constraints & Limitations noted**:
|
|
42
|
+
- Technical constraints (memory, compute)
|
|
43
|
+
- Business constraints (timeline, budget)
|
|
44
|
+
- Regulatory/compliance constraints
|
|
45
|
+
- Breaking changes or migration requirements?
|
|
46
|
+
|
|
47
|
+
## Impact & Scope
|
|
48
|
+
|
|
49
|
+
- [ ] **Affected Systems identified**:
|
|
50
|
+
- Which modules will change? (list by name)
|
|
51
|
+
- Which APIs will change or be added?
|
|
52
|
+
- Which database tables/schemas affected?
|
|
53
|
+
- Frontend routes or pages added/modified?
|
|
54
|
+
|
|
55
|
+
- [ ] **API Surface Changes**:
|
|
56
|
+
- New endpoints needed?
|
|
57
|
+
- Modified endpoint behavior?
|
|
58
|
+
- Deprecated endpoints?
|
|
59
|
+
- Data contract changes?
|
|
60
|
+
|
|
61
|
+
- [ ] **Database Changes**:
|
|
62
|
+
- New tables/collections?
|
|
63
|
+
- Schema migrations?
|
|
64
|
+
- Backward compatibility concerns?
|
|
65
|
+
|
|
66
|
+
- [ ] **UI/UX Changes**:
|
|
67
|
+
- New pages/screens?
|
|
68
|
+
- Modified navigation flows?
|
|
69
|
+
- New user interactions?
|
|
70
|
+
|
|
71
|
+
## Edge Cases & Error Handling
|
|
72
|
+
|
|
73
|
+
- [ ] **Edge Cases enumerated**:
|
|
74
|
+
- Boundary conditions (empty, null, max values)
|
|
75
|
+
- Concurrent operations conflicts
|
|
76
|
+
- Network failures or timeouts
|
|
77
|
+
- Permission/authorization scenarios
|
|
78
|
+
- Race conditions or state inconsistencies
|
|
79
|
+
|
|
80
|
+
- [ ] **Error Scenarios documented**:
|
|
81
|
+
- Invalid input handling
|
|
82
|
+
- Failure recovery strategy
|
|
83
|
+
- User-facing error messages
|
|
84
|
+
- Logging/observability for debugging
|
|
85
|
+
|
|
86
|
+
## Architecture & Design
|
|
87
|
+
|
|
88
|
+
- [ ] **Architectural Pattern chosen**:
|
|
89
|
+
- Synchronous vs. asynchronous?
|
|
90
|
+
- Client-side vs. server-side?
|
|
91
|
+
- Real-time vs. eventual consistency?
|
|
92
|
+
- Distributed or monolithic?
|
|
93
|
+
|
|
94
|
+
- [ ] **Design Decisions recorded** (Why this approach?):
|
|
95
|
+
- What alternatives were considered?
|
|
96
|
+
- Why this one was chosen?
|
|
97
|
+
- Any known tradeoffs?
|
|
98
|
+
|
|
99
|
+
- [ ] **Performance Considerations**:
|
|
100
|
+
- Caching strategy if needed?
|
|
101
|
+
- Query optimization?
|
|
102
|
+
- Batch processing opportunities?
|
|
103
|
+
|
|
104
|
+
## Testing Strategy
|
|
105
|
+
|
|
106
|
+
- [ ] **Test Coverage planned**:
|
|
107
|
+
- Unit tests (which modules?)
|
|
108
|
+
- Integration tests (which interactions?)
|
|
109
|
+
- E2E tests (which user flows?)
|
|
110
|
+
- Target coverage: 80%+ or higher?
|
|
111
|
+
|
|
112
|
+
- [ ] **Test Data & Fixtures**:
|
|
113
|
+
- What test data do we need?
|
|
114
|
+
- Realistic edge case fixtures?
|
|
115
|
+
- Performance test datasets?
|
|
116
|
+
|
|
117
|
+
## Rollout & Monitoring
|
|
118
|
+
|
|
119
|
+
- [ ] **Deployment Strategy**:
|
|
120
|
+
- Staged rollout or all-at-once?
|
|
121
|
+
- Feature flags needed?
|
|
122
|
+
- Rollback plan if issues arise?
|
|
123
|
+
|
|
124
|
+
- [ ] **Monitoring & Observability**:
|
|
125
|
+
- What metrics should we track?
|
|
126
|
+
- Key logs to monitor?
|
|
127
|
+
- Alert thresholds?
|
|
128
|
+
|
|
129
|
+
## Sign-Off
|
|
130
|
+
|
|
131
|
+
- [ ] **Stakeholder confirmation**: Product owner/PM approved?
|
|
132
|
+
- [ ] **Tech lead review**: Architecture and scope approved?
|
|
133
|
+
- [ ] **No unknowns remaining**: All "TBD" fields resolved?
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## Usage
|
|
138
|
+
|
|
139
|
+
Use this checklist **before** calling `/plan` for a new feature:
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
1. Read this checklist
|
|
143
|
+
2. Answer every question (or explicitly mark "not applicable")
|
|
144
|
+
3. If any field is "TBD" or uncertain, add to "Known Unknowns"
|
|
145
|
+
4. Share answers with /plan command
|
|
146
|
+
5. /plan creates implementation strategy
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
## Known Unknowns (for this feature)
|
|
150
|
+
|
|
151
|
+
- [ ] _Add any uncertain items here_
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
**Date**: _YYYY-MM-DD_
|
|
156
|
+
**Author**: _Name_
|
|
157
|
+
**Feature**: _[Feature Name]_
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
# Refactor Q&A Checklist
|
|
2
|
+
|
|
3
|
+
**Purpose**: Structured questionnaire for planning code refactors to avoid scope creep and ensure clarity.
|
|
4
|
+
|
|
5
|
+
**Status**: MANDATORY - Complete before creating refactor plan.
|
|
6
|
+
|
|
7
|
+
## Refactor Goals & Scope
|
|
8
|
+
|
|
9
|
+
- [ ] **Primary goal clearly stated**:
|
|
10
|
+
- Performance improvement? (which metrics?)
|
|
11
|
+
- Code quality/readability?
|
|
12
|
+
- Architecture simplification?
|
|
13
|
+
- Tech debt reduction?
|
|
14
|
+
- Preparation for new feature?
|
|
15
|
+
- Remove deprecated code?
|
|
16
|
+
|
|
17
|
+
- [ ] **Scope boundaries defined**:
|
|
18
|
+
- Exactly which modules/files are in scope?
|
|
19
|
+
- What is explicitly NOT being refactored?
|
|
20
|
+
- Why these boundaries?
|
|
21
|
+
|
|
22
|
+
- [ ] **Success Criteria measurable**:
|
|
23
|
+
- Performance: specific metrics (latency, memory, throughput)?
|
|
24
|
+
- Quality: complexity reduction targets?
|
|
25
|
+
- Lines of code reduction targets?
|
|
26
|
+
- Test coverage maintained/improved?
|
|
27
|
+
|
|
28
|
+
## Impact Assessment
|
|
29
|
+
|
|
30
|
+
- [ ] **Risk Level assessed**:
|
|
31
|
+
- Low risk (isolated, well-tested)?
|
|
32
|
+
- Medium risk (touches multiple areas)?
|
|
33
|
+
- High risk (core/critical system)?
|
|
34
|
+
|
|
35
|
+
- [ ] **Affected Systems identified**:
|
|
36
|
+
- Which modules/components use this code?
|
|
37
|
+
- Public APIs that might change?
|
|
38
|
+
- Dependent code that needs updates?
|
|
39
|
+
- Cross-team dependencies?
|
|
40
|
+
|
|
41
|
+
- [ ] **Breaking Changes evaluated**:
|
|
42
|
+
- Does this change public API?
|
|
43
|
+
- Will clients need updates?
|
|
44
|
+
- Backward compatibility strategy?
|
|
45
|
+
- Deprecation path if needed?
|
|
46
|
+
|
|
47
|
+
- [ ] **Data/State Concerns**:
|
|
48
|
+
- Does this handle state/persistence?
|
|
49
|
+
- Migration strategy if data format changes?
|
|
50
|
+
- Existing data compatibility?
|
|
51
|
+
|
|
52
|
+
## Technical Approach
|
|
53
|
+
|
|
54
|
+
- [ ] **Refactor Strategy decided**:
|
|
55
|
+
- Big bang replacement or incremental?
|
|
56
|
+
- Parallel implementation then cut over?
|
|
57
|
+
- Feature flag strategy?
|
|
58
|
+
- Gradual migration approach?
|
|
59
|
+
|
|
60
|
+
- [ ] **Alternatives considered**:
|
|
61
|
+
- Why this approach over others?
|
|
62
|
+
- Tradeoffs understood?
|
|
63
|
+
- Reversibility of changes?
|
|
64
|
+
|
|
65
|
+
- [ ] **Dependencies researched**:
|
|
66
|
+
- Library/framework upgrades needed?
|
|
67
|
+
- New patterns or tools to learn?
|
|
68
|
+
- Compatibility concerns?
|
|
69
|
+
|
|
70
|
+
## Testing & Verification
|
|
71
|
+
|
|
72
|
+
- [ ] **Test Coverage analyzed**:
|
|
73
|
+
- Current coverage percentage?
|
|
74
|
+
- Coverage targets after refactor?
|
|
75
|
+
- Tests to add during refactor?
|
|
76
|
+
|
|
77
|
+
- [ ] **Regression Testing planned**:
|
|
78
|
+
- Which tests must pass?
|
|
79
|
+
- Integration test scenarios?
|
|
80
|
+
- Performance benchmarks to run?
|
|
81
|
+
- Smoke tests for quick validation?
|
|
82
|
+
|
|
83
|
+
- [ ] **Manual Testing scenarios**:
|
|
84
|
+
- Key user flows to validate?
|
|
85
|
+
- Edge cases to verify?
|
|
86
|
+
- Environment-specific tests (prod-like)?
|
|
87
|
+
|
|
88
|
+
## Performance & Quality Metrics
|
|
89
|
+
|
|
90
|
+
- [ ] **Current metrics captured**:
|
|
91
|
+
- Baseline performance measured?
|
|
92
|
+
- Code quality metrics (complexity, duplication)?
|
|
93
|
+
- Build time benchmarks?
|
|
94
|
+
|
|
95
|
+
- [ ] **Target metrics defined**:
|
|
96
|
+
- Expected performance improvement %?
|
|
97
|
+
- Complexity reduction targets?
|
|
98
|
+
- Build time targets?
|
|
99
|
+
|
|
100
|
+
- [ ] **Monitoring plan**:
|
|
101
|
+
- How will we track post-refactor metrics?
|
|
102
|
+
- Alerts for regressions?
|
|
103
|
+
- A/B testing if applicable?
|
|
104
|
+
|
|
105
|
+
## Timeline & Effort
|
|
106
|
+
|
|
107
|
+
- [ ] **Effort estimated**:
|
|
108
|
+
- Estimated hours/days?
|
|
109
|
+
- Complexity assessment?
|
|
110
|
+
- Blocking dependencies?
|
|
111
|
+
|
|
112
|
+
- [ ] **Schedule considered**:
|
|
113
|
+
- Can this be done incrementally?
|
|
114
|
+
- Best time in release cycle?
|
|
115
|
+
- Sprint capacity available?
|
|
116
|
+
|
|
117
|
+
- [ ] **Rollback plan**:
|
|
118
|
+
- How long to rollback if needed?
|
|
119
|
+
- Can we run A/B test?
|
|
120
|
+
- Version compatibility concerns?
|
|
121
|
+
|
|
122
|
+
## Stakeholder Alignment
|
|
123
|
+
|
|
124
|
+
- [ ] **Team consensus**:
|
|
125
|
+
- Tech lead approved?
|
|
126
|
+
- Code owners agree this is needed?
|
|
127
|
+
- Architecture team aligned?
|
|
128
|
+
|
|
129
|
+
- [ ] **Priority confirmed**:
|
|
130
|
+
- Product owner informed?
|
|
131
|
+
- This won't block feature work?
|
|
132
|
+
- Business case documented?
|
|
133
|
+
|
|
134
|
+
- [ ] **Knowledge sharing**:
|
|
135
|
+
- Team trained on new patterns?
|
|
136
|
+
- Documentation updated?
|
|
137
|
+
- Code review guidelines updated?
|
|
138
|
+
|
|
139
|
+
## Documentation & Communication
|
|
140
|
+
|
|
141
|
+
- [ ] **Refactor Plan documented**:
|
|
142
|
+
- Current state architecture?
|
|
143
|
+
- Target state architecture?
|
|
144
|
+
- Migration path clearly described?
|
|
145
|
+
|
|
146
|
+
- [ ] **Design Decision recorded**:
|
|
147
|
+
- ADR created explaining refactor?
|
|
148
|
+
- Links to discussions/research?
|
|
149
|
+
- Why-decisions documented?
|
|
150
|
+
|
|
151
|
+
- [ ] **Communication plan**:
|
|
152
|
+
- Stakeholders notified?
|
|
153
|
+
- Progress updates planned?
|
|
154
|
+
- Release notes prepared?
|
|
155
|
+
|
|
156
|
+
## Code Quality Standards
|
|
157
|
+
|
|
158
|
+
- [ ] **Code Quality Checklist**:
|
|
159
|
+
- Follows team conventions?
|
|
160
|
+
- No hardcoded values?
|
|
161
|
+
- Proper error handling?
|
|
162
|
+
- Comprehensive logging?
|
|
163
|
+
- Immutable patterns used?
|
|
164
|
+
|
|
165
|
+
- [ ] **Security considerations**:
|
|
166
|
+
- No security regressions?
|
|
167
|
+
- Secrets handling correct?
|
|
168
|
+
- Access control maintained?
|
|
169
|
+
|
|
170
|
+
- [ ] **Performance considerations**:
|
|
171
|
+
- Efficiency improvements realized?
|
|
172
|
+
- No performance regressions?
|
|
173
|
+
- Caching used appropriately?
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## Usage
|
|
178
|
+
|
|
179
|
+
Use this checklist **before** calling `/plan refactor`:
|
|
180
|
+
|
|
181
|
+
```
|
|
182
|
+
1. Read this checklist completely
|
|
183
|
+
2. Answer all questions
|
|
184
|
+
3. Get stakeholder alignment on scope
|
|
185
|
+
4. Capture current metrics
|
|
186
|
+
5. Define success criteria
|
|
187
|
+
6. Create implementation plan
|
|
188
|
+
7. Execute incrementally with verification
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## Pre-Refactor Checklist
|
|
192
|
+
|
|
193
|
+
Before starting actual refactoring:
|
|
194
|
+
- [ ] All tests passing in current state?
|
|
195
|
+
- [ ] Current metrics captured/documented?
|
|
196
|
+
- [ ] Feature branch created?
|
|
197
|
+
- [ ] Notification sent to team?
|
|
198
|
+
- [ ] Rollback plan documented and tested?
|
|
199
|
+
|
|
200
|
+
## Refactor Type
|
|
201
|
+
|
|
202
|
+
Choose one:
|
|
203
|
+
- [ ] Performance optimization
|
|
204
|
+
- [ ] Code quality improvement
|
|
205
|
+
- [ ] Architecture simplification
|
|
206
|
+
- [ ] Tech debt reduction
|
|
207
|
+
- [ ] Pattern standardization
|
|
208
|
+
- [ ] Library/framework upgrade
|
|
209
|
+
- [ ] Other: _specify_
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
**Checklist Completed**: ☐
|
|
214
|
+
**Date**: _YYYY-MM-DD_
|
|
215
|
+
**Lead**: _Name_
|
|
216
|
+
**Reviewers**: _Names_
|