codex-genesis-harness 0.1.5 → 0.1.7
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 -216
- package/.codebase/CURRENT_STATE.md +8 -2
- package/.codebase/FILE_NAMING_CLARIFICATION.md +161 -161
- package/.codebase/HARNESS_COMPLETENESS_AUDIT.md +613 -613
- package/.codebase/IMPLEMENTATION_COMPLETE.md +429 -429
- package/.codebase/IMPLEMENTATION_HANDOFF.md +351 -351
- package/.codebase/IMPROVEMENTS_SUMMARY.md +419 -419
- package/.codebase/PHASE3_SKILLS_NAMING_COMPLETE.md +292 -292
- package/.codebase/PHASE_DEPENDENCY_MAP.md +486 -486
- package/.codebase/QUICK_START_SPEC_IMPACT.md +456 -456
- package/.codebase/README.md +139 -139
- package/.codebase/RECOVERY_POINTS.md +83 -438
- package/.codebase/beads.json +16 -0
- package/.codex/skills/genesis-ai-provider/SKILL.md +1 -1
- package/.codex/skills/genesis-api-contract/SKILL.md +1 -1
- package/.codex/skills/genesis-api-sync/SKILL.md +354 -354
- package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -101
- package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -257
- package/.codex/skills/genesis-architecture/SKILL.md +1 -1
- package/.codex/skills/genesis-codebase-map/SKILL.md +1 -1
- package/.codex/skills/genesis-debug-guide/SKILL.md +479 -479
- package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -339
- package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -210
- package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -158
- package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -365
- package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -289
- package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -288
- package/.codex/skills/genesis-design-spec/SKILL.md +3 -3
- package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -1003
- package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -359
- package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -312
- package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -382
- package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -851
- package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -491
- package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -187
- package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -297
- package/.codex/skills/genesis-harness/SKILL.md +1428 -1427
- package/.codex/skills/genesis-harness/agents/openai.yaml +7 -7
- package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -169
- package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -157
- package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -216
- package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -211
- package/.codex/skills/genesis-harness/references/planning-schema.md +35 -35
- package/.codex/skills/genesis-harness/references/quality-rubric.md +21 -21
- package/.codex/skills/genesis-harness/references/research-rubric.md +41 -41
- package/.codex/skills/genesis-harness/references/workflows.md +33 -33
- package/.codex/skills/genesis-harness/resources/agents-template.md +27 -27
- package/.codex/skills/genesis-harness/resources/api-docs-template.md +32 -32
- package/.codex/skills/genesis-harness/resources/architecture-template.md +30 -30
- package/.codex/skills/genesis-harness/resources/audit-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/bug-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -204
- package/.codex/skills/genesis-harness/resources/check-template.md +21 -21
- package/.codex/skills/genesis-harness/resources/conventions-template.md +42 -42
- package/.codex/skills/genesis-harness/resources/decision-template.md +33 -33
- package/.codex/skills/genesis-harness/resources/design-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/escalation-template.md +21 -21
- package/.codex/skills/genesis-harness/resources/feature-template.md +49 -49
- package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -131
- package/.codex/skills/genesis-harness/resources/integrations-template.md +32 -32
- package/.codex/skills/genesis-harness/resources/journeys-template.md +13 -13
- package/.codex/skills/genesis-harness/resources/lessons-learned-template.md +12 -12
- package/.codex/skills/genesis-harness/resources/observability-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -76
- package/.codex/skills/genesis-harness/resources/phase-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/pitfalls-template.md +22 -22
- package/.codex/skills/genesis-harness/resources/planning-tree-template.md +39 -39
- package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -347
- package/.codex/skills/genesis-harness/resources/project-template.md +38 -38
- package/.codex/skills/genesis-harness/resources/quality-score-template.md +11 -11
- package/.codex/skills/genesis-harness/resources/requirements-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/research-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/review-template.md +22 -22
- package/.codex/skills/genesis-harness/resources/spec-changelog-template.md +6 -6
- package/.codex/skills/genesis-harness/resources/stack-template.md +33 -33
- package/.codex/skills/genesis-harness/resources/verification-template.md +26 -26
- package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/compact-context.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-adr.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-bug.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-feature.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/detect-stack.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/init-planning.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/offload-log.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/run-verification.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/update-state.sh +0 -0
- package/.codex/skills/genesis-harness-engineering/SKILL.md +1 -1
- package/.codex/skills/genesis-new-design/SKILL.md +2 -1
- package/.codex/skills/genesis-new-design/agents/openai.yaml +3 -3
- package/.codex/skills/genesis-observability-automation/checklists/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/observability/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/playbooks/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/templates/.gitkeep +0 -0
- package/.codex/skills/genesis-pipeline-orchestration/SKILL.md +1 -1
- package/.codex/skills/genesis-planning/SKILL.md +26 -1
- package/.codex/skills/genesis-planning/checklists/mvp-readiness.md +18 -0
- package/.codex/skills/genesis-planning/examples/5-phase-roadmap-example.md +43 -0
- package/.codex/skills/genesis-planning/templates/phase-1-core.md +17 -0
- package/.codex/skills/genesis-planning/templates/phase-2-auth.md +17 -0
- package/.codex/skills/genesis-planning/templates/phase-3-features.md +17 -0
- package/.codex/skills/genesis-planning/templates/phase-4-integrations.md +17 -0
- package/.codex/skills/genesis-planning/templates/phase-5-readiness.md +17 -0
- package/.codex/skills/genesis-release/SKILL.md +24 -1
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/checklists/post-deployment-verification.md +274 -274
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/checklists/pre-release-validation.md +220 -220
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/observability/release-tracking.md +253 -253
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/playbooks/canary-deployment-orchestration.md +472 -472
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/playbooks/semantic-versioning-automation.md +494 -494
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/templates/deployment-strategy-template.md +303 -303
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/templates/release-runbook-template.md +420 -420
- package/.codex/skills/genesis-research-first/SKILL.md +237 -237
- package/.codex/skills/genesis-research-first/templates/.gitkeep +0 -0
- package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -534
- package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -384
- package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -257
- package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -373
- package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -692
- package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -434
- package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -407
- package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/SKILL.md +1 -1
- package/.codex/skills/genesis-upgrade-design/agents/openai.yaml +3 -3
- package/.codex/skills/spec-impact-engine/SKILL.md +504 -504
- package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +0 -0
- package/.codex-plugin/plugin.json +19 -19
- package/CHANGELOG.md +56 -0
- package/LICENSE +22 -22
- package/README.EN.md +780 -730
- package/README.VI.md +772 -723
- package/README.md +102 -247
- package/VERSION +2 -2
- package/bin/genesis-harness.js +695 -92
- package/package.json +9 -3
- package/scripts/README.md +342 -342
- package/scripts/compact-context.sh +0 -0
- package/scripts/contract_integrity_gate.js +83 -0
- package/scripts/detect-changes.sh +0 -0
- package/scripts/healing_telemetry.js +118 -0
- package/scripts/install.sh +5 -6
- package/scripts/offload-log.sh +0 -0
- package/scripts/prompt_sentinel.js +84 -0
- package/scripts/run-evals.sh +20 -24
- package/scripts/run-verify-loop.sh +11 -0
- package/scripts/spec_visual_sync.js +157 -0
- package/scripts/test_generator.js +142 -0
- package/scripts/transition_state.sh +0 -0
- package/scripts/uninstall.sh +2 -5
- package/scripts/validation_gates.sh +40 -1
- package/scripts/verify.sh +6 -61
- package/tests/unit/contract_integrity_gate.test.js +74 -0
- package/tests/unit/healing_telemetry.test.js +58 -0
- package/tests/unit/prompt_sentinel.test.js +50 -0
- package/tests/unit/spec_visual_sync.test.js +77 -0
- package/tests/unit/test_generator.test.js +62 -0
- package/.codex/skills/genesis-docs/SKILL.md +0 -46
- package/.codex/skills/genesis-docs/agents/openai.yaml +0 -7
- package/.codex/skills/genesis-release-orchestration/SKILL.md +0 -653
- package/.codex/skills/genesis-release-orchestration/agents/openai.yaml +0 -7
- package/.codex/skills/genesis-research/SKILL.md +0 -46
- package/.codex/skills/genesis-research/agents/openai.yaml +0 -7
- /package/.codex/skills/{genesis-docs/checklists/checklist.md → genesis-docs-automation/checklists/manual-docs-checklist.md} +0 -0
- /package/.codex/skills/{genesis-docs/examples/example.md → genesis-docs-automation/examples/manual-docs-example.md} +0 -0
- /package/.codex/skills/{genesis-docs → genesis-docs-automation}/templates/docs-update-template.md +0 -0
- /package/.codex/skills/{genesis-state-machine/SKILL.md → genesis-harness/references/state-machine.md} +0 -0
- /package/.codex/skills/{genesis-release-orchestration/examples/example.md → genesis-release/examples/orchestration-example.md} +0 -0
- /package/.codex/skills/{genesis-research → genesis-research-first}/checklists/checklist.md +0 -0
- /package/.codex/skills/{genesis-research/examples/example.md → genesis-research-first/examples/manual-research-example.md} +0 -0
- /package/.codex/skills/{genesis-research → genesis-research-first}/templates/research-note-template.md +0 -0
- /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/agents/openai.yaml +0 -0
- /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/checklists/checklist.md +0 -0
- /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/examples/example.md +0 -0
- /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/templates/playwright-test-template.md +0 -0
|
@@ -1,216 +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_
|
|
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_
|