codex-genesis-harness 0.1.4 → 0.1.6
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 +9 -7
- 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 +438 -438
- package/.codebase/state.json +37 -0
- 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-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-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 +1427 -1418
- 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-mvp-planning/SKILL.md +114 -0
- package/.codex/skills/genesis-mvp-planning/agents/openai.yaml +6 -0
- package/.codex/skills/genesis-mvp-planning/checklists/mvp-readiness.md +18 -0
- package/.codex/skills/genesis-mvp-planning/examples/5-phase-roadmap-example.md +43 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-1-core.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-2-auth.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-3-features.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-4-integrations.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-5-readiness.md +17 -0
- 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-release-orchestration/SKILL.md +653 -653
- package/.codex/skills/genesis-release-orchestration/checklists/post-deployment-verification.md +274 -274
- package/.codex/skills/genesis-release-orchestration/checklists/pre-release-validation.md +220 -220
- package/.codex/skills/genesis-release-orchestration/observability/release-tracking.md +253 -253
- package/.codex/skills/genesis-release-orchestration/playbooks/canary-deployment-orchestration.md +472 -472
- package/.codex/skills/genesis-release-orchestration/playbooks/semantic-versioning-automation.md +494 -494
- package/.codex/skills/genesis-release-orchestration/templates/deployment-strategy-template.md +303 -303
- package/.codex/skills/genesis-release-orchestration/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/genesis-state-machine/SKILL.md +34 -0
- 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 +24 -24
- package/CHANGELOG.md +42 -0
- package/LICENSE +22 -22
- package/README.EN.md +784 -719
- package/README.VI.md +776 -712
- package/README.md +113 -253
- package/VERSION +2 -2
- package/bin/genesis-harness.js +90 -87
- package/package.json +68 -43
- 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 +4 -1
- package/scripts/offload-log.sh +0 -0
- package/scripts/prompt_sentinel.js +84 -0
- package/scripts/run-evals.sh +1 -0
- 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 +67 -0
- package/scripts/uninstall.sh +1 -0
- package/scripts/validation_gates.sh +85 -0
- package/scripts/verify.sh +5 -0
- 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
|
@@ -1,204 +1,204 @@
|
|
|
1
|
-
# Change Impact Matrix
|
|
2
|
-
|
|
3
|
-
**What docs must be updated when different types of changes are made.**
|
|
4
|
-
|
|
5
|
-
Use this matrix to identify all docs that need updating for your feature/bug fix.
|
|
6
|
-
|
|
7
|
-
## Feature: Behavior Changed
|
|
8
|
-
|
|
9
|
-
**You changed**:
|
|
10
|
-
- User-facing behavior
|
|
11
|
-
- Acceptance criteria
|
|
12
|
-
- Requirement fulfilled
|
|
13
|
-
|
|
14
|
-
**Update these docs**:
|
|
15
|
-
- [ ] `.planning/REQUIREMENTS.md` - Document new requirement
|
|
16
|
-
- [ ] `.planning/SPEC_CHANGELOG.md` - Record the change
|
|
17
|
-
- [ ] `.planning/STATE.md` - Update current status
|
|
18
|
-
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
19
|
-
- [ ] `.planning/FEATURE_INDEX.md` - Feature status
|
|
20
|
-
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate coverage
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Feature: API Changed
|
|
25
|
-
|
|
26
|
-
**You changed**:
|
|
27
|
-
- New endpoints
|
|
28
|
-
- Request/response schemas
|
|
29
|
-
- Auth mechanism
|
|
30
|
-
- Error responses
|
|
31
|
-
- Breaking changes
|
|
32
|
-
|
|
33
|
-
**Update these docs**:
|
|
34
|
-
- [ ] `.planning/API_DOCS.md` - Document new/changed endpoints
|
|
35
|
-
- [ ] `.planning/REQUIREMENTS.md` - Behavior changes
|
|
36
|
-
- [ ] `.planning/INTEGRATIONS.md` - If auth/secrets changed
|
|
37
|
-
- [ ] `.planning/SPEC_CHANGELOG.md` - Record API changes with migration notes
|
|
38
|
-
- [ ] `.planning/STATE.md` - Current phase
|
|
39
|
-
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
40
|
-
- [ ] `.planning/FEATURE_INDEX.md` - Feature status
|
|
41
|
-
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate API coverage
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
## Feature: Database Changed
|
|
46
|
-
|
|
47
|
-
**You changed**:
|
|
48
|
-
- New tables/collections
|
|
49
|
-
- Schema modifications
|
|
50
|
-
- Data migrations
|
|
51
|
-
- Queries/indexes
|
|
52
|
-
|
|
53
|
-
**Update these docs**:
|
|
54
|
-
- [ ] `.planning/ARCHITECTURE.md` - New data models/schema
|
|
55
|
-
- [ ] `.planning/diagrams/database-erd.mmd` - Update ERD
|
|
56
|
-
- [ ] `.planning/SPEC_CHANGELOG.md` - Record schema changes with migration steps
|
|
57
|
-
- [ ] `.planning/STATE.md` - Current phase
|
|
58
|
-
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
59
|
-
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate architecture coverage
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
## Feature: UI/UX Changed
|
|
64
|
-
|
|
65
|
-
**You changed**:
|
|
66
|
-
- New screens/pages
|
|
67
|
-
- Component structure
|
|
68
|
-
- User flows
|
|
69
|
-
- Navigation
|
|
70
|
-
- Accessibility
|
|
71
|
-
|
|
72
|
-
**Update these docs**:
|
|
73
|
-
- [ ] `.planning/DESIGN.md` - New screens/components/flow
|
|
74
|
-
- [ ] `.planning/JOURNEYS.md` - Updated user journeys
|
|
75
|
-
- [ ] `.planning/SMOKE_TESTS.md` - New verification paths
|
|
76
|
-
- [ ] `.planning/diagrams/system-context.mmd` - If flows changed
|
|
77
|
-
- [ ] `.planning/SPEC_CHANGELOG.md` - Record UI changes
|
|
78
|
-
- [ ] `.planning/STATE.md` - Current phase
|
|
79
|
-
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
80
|
-
- [ ] `.planning/FEATURE_INDEX.md` - Feature status
|
|
81
|
-
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate design coverage
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
## Feature: Architecture Changed
|
|
86
|
-
|
|
87
|
-
**You changed**:
|
|
88
|
-
- Module boundaries
|
|
89
|
-
- Service structure
|
|
90
|
-
- Dependency direction
|
|
91
|
-
- Data flow
|
|
92
|
-
- Design patterns
|
|
93
|
-
|
|
94
|
-
**Update these docs**:
|
|
95
|
-
- [ ] `.planning/ARCHITECTURE.md` - New module boundaries, patterns, principles
|
|
96
|
-
- [ ] `.planning/diagrams/container-architecture.mmd` - Update architecture diagram
|
|
97
|
-
- [ ] `.planning/diagrams/deployment-flow.mmd` - If deployment changed
|
|
98
|
-
- [ ] `.planning/CONVENTIONS.md` - New patterns to follow
|
|
99
|
-
- [ ] `.planning/decisions/ADR-XXX-*.md` - Create ADR for major decision
|
|
100
|
-
- [ ] `.planning/SPEC_CHANGELOG.md` - Record architecture changes
|
|
101
|
-
- [ ] `.planning/STATE.md` - Current phase
|
|
102
|
-
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
103
|
-
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate architecture score
|
|
104
|
-
|
|
105
|
-
---
|
|
106
|
-
|
|
107
|
-
## Feature: Integration Changed
|
|
108
|
-
|
|
109
|
-
**You changed**:
|
|
110
|
-
- New external services
|
|
111
|
-
- API keys/secrets
|
|
112
|
-
- Webhooks
|
|
113
|
-
- Rate limits
|
|
114
|
-
- Fallback strategies
|
|
115
|
-
|
|
116
|
-
**Update these docs**:
|
|
117
|
-
- [ ] `.planning/INTEGRATIONS.md` - New services, env vars, failure handling
|
|
118
|
-
- [ ] `.planning/STACK.md` - New dependencies
|
|
119
|
-
- [ ] `.planning/OBSERVABILITY.md` - New error handling/logs
|
|
120
|
-
- [ ] `.planning/SPEC_CHANGELOG.md` - Record integration changes
|
|
121
|
-
- [ ] `.planning/STATE.md` - Current phase
|
|
122
|
-
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
123
|
-
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate integration coverage
|
|
124
|
-
|
|
125
|
-
---
|
|
126
|
-
|
|
127
|
-
## Feature: Configuration/Environment Changed
|
|
128
|
-
|
|
129
|
-
**You changed**:
|
|
130
|
-
- New env variables
|
|
131
|
-
- Config files
|
|
132
|
-
- Build process
|
|
133
|
-
- Runtime environment
|
|
134
|
-
- Deployment parameters
|
|
135
|
-
|
|
136
|
-
**Update these docs**:
|
|
137
|
-
- [ ] `.planning/STACK.md` - New commands, env vars, versions
|
|
138
|
-
- [ ] `.planning/INTEGRATIONS.md` - New secrets/config
|
|
139
|
-
- [ ] `.planning/CONVENTIONS.md` - New rules
|
|
140
|
-
- [ ] `.planning/diagrams/deployment-flow.mmd` - If deployment changed
|
|
141
|
-
- [ ] `.planning/SPEC_CHANGELOG.md` - Record config changes
|
|
142
|
-
- [ ] `.planning/STATE.md` - Current phase
|
|
143
|
-
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
144
|
-
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate coverage
|
|
145
|
-
|
|
146
|
-
---
|
|
147
|
-
|
|
148
|
-
## Bug Fix: Behavior Corrected
|
|
149
|
-
|
|
150
|
-
**You fixed**:
|
|
151
|
-
- Incorrect behavior
|
|
152
|
-
- Edge case handling
|
|
153
|
-
- Error recovery
|
|
154
|
-
|
|
155
|
-
**Update these docs**:
|
|
156
|
-
- [ ] `.planning/LESSONS_LEARNED.md` - Document root cause, prevention
|
|
157
|
-
- [ ] `.planning/SPEC_CHANGELOG.md` - Record fix
|
|
158
|
-
- [ ] `.planning/PITFALLS.md` - Add prevention rule if applicable
|
|
159
|
-
- [ ] `.planning/STATE.md` - Current phase
|
|
160
|
-
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
161
|
-
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate
|
|
162
|
-
|
|
163
|
-
---
|
|
164
|
-
|
|
165
|
-
## Refactor: No Behavior Change
|
|
166
|
-
|
|
167
|
-
**You changed**:
|
|
168
|
-
- Internal code organization
|
|
169
|
-
- Performance optimization
|
|
170
|
-
- Dependency updates
|
|
171
|
-
- Code cleanup
|
|
172
|
-
|
|
173
|
-
**Update these docs**:
|
|
174
|
-
- [ ] `.planning/ARCHITECTURE.md` - If structure clarified
|
|
175
|
-
- [ ] `.planning/CONVENTIONS.md` - If patterns improved
|
|
176
|
-
- [ ] `.planning/LESSONS_LEARNED.md` - Document why refactor needed
|
|
177
|
-
- [ ] `.planning/STATE.md` - Current phase
|
|
178
|
-
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
179
|
-
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate maintainability
|
|
180
|
-
|
|
181
|
-
---
|
|
182
|
-
|
|
183
|
-
## Always Update
|
|
184
|
-
|
|
185
|
-
**Regardless of change type, ALWAYS update:**
|
|
186
|
-
|
|
187
|
-
- [ ] `.planning/STATE.md` - current phase, active feature, next task
|
|
188
|
-
- [ ] `.planning/SUMMARY.md` - recent changes, next recommended task
|
|
189
|
-
- [ ] `.planning/SPEC_CHANGELOG.md` - date, reason, impacted docs, migration notes
|
|
190
|
-
- [ ] `.planning/FEATURE_INDEX.md` or `.planning/bugs/` - status update
|
|
191
|
-
|
|
192
|
-
**Exception**: Internal refactor with zero behavior change can skip SPEC_CHANGELOG if justified.
|
|
193
|
-
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
## How to Use This Matrix
|
|
197
|
-
|
|
198
|
-
1. **Identify change type** above (Feature: API Changed? Bug Fix? etc.)
|
|
199
|
-
2. **Check all boxes** that apply
|
|
200
|
-
3. **Update each doc** listed
|
|
201
|
-
4. **Verify** with checklist in Definition of Done
|
|
202
|
-
5. **Add to SPEC_CHANGELOG.md** as final proof
|
|
203
|
-
|
|
204
|
-
**If you forget to update a doc**: Spec drift → future bugs → technical debt → expensive rewrites.
|
|
1
|
+
# Change Impact Matrix
|
|
2
|
+
|
|
3
|
+
**What docs must be updated when different types of changes are made.**
|
|
4
|
+
|
|
5
|
+
Use this matrix to identify all docs that need updating for your feature/bug fix.
|
|
6
|
+
|
|
7
|
+
## Feature: Behavior Changed
|
|
8
|
+
|
|
9
|
+
**You changed**:
|
|
10
|
+
- User-facing behavior
|
|
11
|
+
- Acceptance criteria
|
|
12
|
+
- Requirement fulfilled
|
|
13
|
+
|
|
14
|
+
**Update these docs**:
|
|
15
|
+
- [ ] `.planning/REQUIREMENTS.md` - Document new requirement
|
|
16
|
+
- [ ] `.planning/SPEC_CHANGELOG.md` - Record the change
|
|
17
|
+
- [ ] `.planning/STATE.md` - Update current status
|
|
18
|
+
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
19
|
+
- [ ] `.planning/FEATURE_INDEX.md` - Feature status
|
|
20
|
+
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate coverage
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Feature: API Changed
|
|
25
|
+
|
|
26
|
+
**You changed**:
|
|
27
|
+
- New endpoints
|
|
28
|
+
- Request/response schemas
|
|
29
|
+
- Auth mechanism
|
|
30
|
+
- Error responses
|
|
31
|
+
- Breaking changes
|
|
32
|
+
|
|
33
|
+
**Update these docs**:
|
|
34
|
+
- [ ] `.planning/API_DOCS.md` - Document new/changed endpoints
|
|
35
|
+
- [ ] `.planning/REQUIREMENTS.md` - Behavior changes
|
|
36
|
+
- [ ] `.planning/INTEGRATIONS.md` - If auth/secrets changed
|
|
37
|
+
- [ ] `.planning/SPEC_CHANGELOG.md` - Record API changes with migration notes
|
|
38
|
+
- [ ] `.planning/STATE.md` - Current phase
|
|
39
|
+
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
40
|
+
- [ ] `.planning/FEATURE_INDEX.md` - Feature status
|
|
41
|
+
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate API coverage
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Feature: Database Changed
|
|
46
|
+
|
|
47
|
+
**You changed**:
|
|
48
|
+
- New tables/collections
|
|
49
|
+
- Schema modifications
|
|
50
|
+
- Data migrations
|
|
51
|
+
- Queries/indexes
|
|
52
|
+
|
|
53
|
+
**Update these docs**:
|
|
54
|
+
- [ ] `.planning/ARCHITECTURE.md` - New data models/schema
|
|
55
|
+
- [ ] `.planning/diagrams/database-erd.mmd` - Update ERD
|
|
56
|
+
- [ ] `.planning/SPEC_CHANGELOG.md` - Record schema changes with migration steps
|
|
57
|
+
- [ ] `.planning/STATE.md` - Current phase
|
|
58
|
+
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
59
|
+
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate architecture coverage
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Feature: UI/UX Changed
|
|
64
|
+
|
|
65
|
+
**You changed**:
|
|
66
|
+
- New screens/pages
|
|
67
|
+
- Component structure
|
|
68
|
+
- User flows
|
|
69
|
+
- Navigation
|
|
70
|
+
- Accessibility
|
|
71
|
+
|
|
72
|
+
**Update these docs**:
|
|
73
|
+
- [ ] `.planning/DESIGN.md` - New screens/components/flow
|
|
74
|
+
- [ ] `.planning/JOURNEYS.md` - Updated user journeys
|
|
75
|
+
- [ ] `.planning/SMOKE_TESTS.md` - New verification paths
|
|
76
|
+
- [ ] `.planning/diagrams/system-context.mmd` - If flows changed
|
|
77
|
+
- [ ] `.planning/SPEC_CHANGELOG.md` - Record UI changes
|
|
78
|
+
- [ ] `.planning/STATE.md` - Current phase
|
|
79
|
+
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
80
|
+
- [ ] `.planning/FEATURE_INDEX.md` - Feature status
|
|
81
|
+
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate design coverage
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Feature: Architecture Changed
|
|
86
|
+
|
|
87
|
+
**You changed**:
|
|
88
|
+
- Module boundaries
|
|
89
|
+
- Service structure
|
|
90
|
+
- Dependency direction
|
|
91
|
+
- Data flow
|
|
92
|
+
- Design patterns
|
|
93
|
+
|
|
94
|
+
**Update these docs**:
|
|
95
|
+
- [ ] `.planning/ARCHITECTURE.md` - New module boundaries, patterns, principles
|
|
96
|
+
- [ ] `.planning/diagrams/container-architecture.mmd` - Update architecture diagram
|
|
97
|
+
- [ ] `.planning/diagrams/deployment-flow.mmd` - If deployment changed
|
|
98
|
+
- [ ] `.planning/CONVENTIONS.md` - New patterns to follow
|
|
99
|
+
- [ ] `.planning/decisions/ADR-XXX-*.md` - Create ADR for major decision
|
|
100
|
+
- [ ] `.planning/SPEC_CHANGELOG.md` - Record architecture changes
|
|
101
|
+
- [ ] `.planning/STATE.md` - Current phase
|
|
102
|
+
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
103
|
+
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate architecture score
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## Feature: Integration Changed
|
|
108
|
+
|
|
109
|
+
**You changed**:
|
|
110
|
+
- New external services
|
|
111
|
+
- API keys/secrets
|
|
112
|
+
- Webhooks
|
|
113
|
+
- Rate limits
|
|
114
|
+
- Fallback strategies
|
|
115
|
+
|
|
116
|
+
**Update these docs**:
|
|
117
|
+
- [ ] `.planning/INTEGRATIONS.md` - New services, env vars, failure handling
|
|
118
|
+
- [ ] `.planning/STACK.md` - New dependencies
|
|
119
|
+
- [ ] `.planning/OBSERVABILITY.md` - New error handling/logs
|
|
120
|
+
- [ ] `.planning/SPEC_CHANGELOG.md` - Record integration changes
|
|
121
|
+
- [ ] `.planning/STATE.md` - Current phase
|
|
122
|
+
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
123
|
+
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate integration coverage
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## Feature: Configuration/Environment Changed
|
|
128
|
+
|
|
129
|
+
**You changed**:
|
|
130
|
+
- New env variables
|
|
131
|
+
- Config files
|
|
132
|
+
- Build process
|
|
133
|
+
- Runtime environment
|
|
134
|
+
- Deployment parameters
|
|
135
|
+
|
|
136
|
+
**Update these docs**:
|
|
137
|
+
- [ ] `.planning/STACK.md` - New commands, env vars, versions
|
|
138
|
+
- [ ] `.planning/INTEGRATIONS.md` - New secrets/config
|
|
139
|
+
- [ ] `.planning/CONVENTIONS.md` - New rules
|
|
140
|
+
- [ ] `.planning/diagrams/deployment-flow.mmd` - If deployment changed
|
|
141
|
+
- [ ] `.planning/SPEC_CHANGELOG.md` - Record config changes
|
|
142
|
+
- [ ] `.planning/STATE.md` - Current phase
|
|
143
|
+
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
144
|
+
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate coverage
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Bug Fix: Behavior Corrected
|
|
149
|
+
|
|
150
|
+
**You fixed**:
|
|
151
|
+
- Incorrect behavior
|
|
152
|
+
- Edge case handling
|
|
153
|
+
- Error recovery
|
|
154
|
+
|
|
155
|
+
**Update these docs**:
|
|
156
|
+
- [ ] `.planning/LESSONS_LEARNED.md` - Document root cause, prevention
|
|
157
|
+
- [ ] `.planning/SPEC_CHANGELOG.md` - Record fix
|
|
158
|
+
- [ ] `.planning/PITFALLS.md` - Add prevention rule if applicable
|
|
159
|
+
- [ ] `.planning/STATE.md` - Current phase
|
|
160
|
+
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
161
|
+
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## Refactor: No Behavior Change
|
|
166
|
+
|
|
167
|
+
**You changed**:
|
|
168
|
+
- Internal code organization
|
|
169
|
+
- Performance optimization
|
|
170
|
+
- Dependency updates
|
|
171
|
+
- Code cleanup
|
|
172
|
+
|
|
173
|
+
**Update these docs**:
|
|
174
|
+
- [ ] `.planning/ARCHITECTURE.md` - If structure clarified
|
|
175
|
+
- [ ] `.planning/CONVENTIONS.md` - If patterns improved
|
|
176
|
+
- [ ] `.planning/LESSONS_LEARNED.md` - Document why refactor needed
|
|
177
|
+
- [ ] `.planning/STATE.md` - Current phase
|
|
178
|
+
- [ ] `.planning/SUMMARY.md` - Recent changes
|
|
179
|
+
- [ ] `.planning/QUALITY_SCORE.md` - Recalculate maintainability
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## Always Update
|
|
184
|
+
|
|
185
|
+
**Regardless of change type, ALWAYS update:**
|
|
186
|
+
|
|
187
|
+
- [ ] `.planning/STATE.md` - current phase, active feature, next task
|
|
188
|
+
- [ ] `.planning/SUMMARY.md` - recent changes, next recommended task
|
|
189
|
+
- [ ] `.planning/SPEC_CHANGELOG.md` - date, reason, impacted docs, migration notes
|
|
190
|
+
- [ ] `.planning/FEATURE_INDEX.md` or `.planning/bugs/` - status update
|
|
191
|
+
|
|
192
|
+
**Exception**: Internal refactor with zero behavior change can skip SPEC_CHANGELOG if justified.
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## How to Use This Matrix
|
|
197
|
+
|
|
198
|
+
1. **Identify change type** above (Feature: API Changed? Bug Fix? etc.)
|
|
199
|
+
2. **Check all boxes** that apply
|
|
200
|
+
3. **Update each doc** listed
|
|
201
|
+
4. **Verify** with checklist in Definition of Done
|
|
202
|
+
5. **Add to SPEC_CHANGELOG.md** as final proof
|
|
203
|
+
|
|
204
|
+
**If you forget to update a doc**: Spec drift → future bugs → technical debt → expensive rewrites.
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
# Check
|
|
2
|
-
|
|
3
|
-
## Purpose
|
|
4
|
-
|
|
5
|
-
TBD
|
|
6
|
-
|
|
7
|
-
## Command
|
|
8
|
-
|
|
9
|
-
```sh
|
|
10
|
-
# TBD
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Pass Criteria
|
|
14
|
-
|
|
15
|
-
- [ ] TBD
|
|
16
|
-
|
|
17
|
-
## Failure Action
|
|
18
|
-
|
|
19
|
-
- [ ] Update tracking
|
|
20
|
-
- [ ] Fix issue or document escalation
|
|
21
|
-
- [ ] Rerun verification
|
|
1
|
+
# Check
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
TBD
|
|
6
|
+
|
|
7
|
+
## Command
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
# TBD
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Pass Criteria
|
|
14
|
+
|
|
15
|
+
- [ ] TBD
|
|
16
|
+
|
|
17
|
+
## Failure Action
|
|
18
|
+
|
|
19
|
+
- [ ] Update tracking
|
|
20
|
+
- [ ] Fix issue or document escalation
|
|
21
|
+
- [ ] Rerun verification
|
|
@@ -1,42 +1,42 @@
|
|
|
1
|
-
# Conventions
|
|
2
|
-
|
|
3
|
-
## Naming
|
|
4
|
-
|
|
5
|
-
- [ ] TBD
|
|
6
|
-
|
|
7
|
-
## Folders
|
|
8
|
-
|
|
9
|
-
- [ ] TBD
|
|
10
|
-
|
|
11
|
-
## Code Style
|
|
12
|
-
|
|
13
|
-
- [ ] TBD
|
|
14
|
-
|
|
15
|
-
## Error Handling
|
|
16
|
-
|
|
17
|
-
- [ ] TBD
|
|
18
|
-
|
|
19
|
-
## Logging
|
|
20
|
-
|
|
21
|
-
- [ ] TBD
|
|
22
|
-
|
|
23
|
-
## Testing
|
|
24
|
-
|
|
25
|
-
- [ ] TBD
|
|
26
|
-
|
|
27
|
-
## API
|
|
28
|
-
|
|
29
|
-
- [ ] TBD
|
|
30
|
-
|
|
31
|
-
## Security
|
|
32
|
-
|
|
33
|
-
- [ ] TBD
|
|
34
|
-
|
|
35
|
-
## Patterns To Follow
|
|
36
|
-
|
|
37
|
-
- [ ] TBD
|
|
38
|
-
|
|
39
|
-
## Patterns To Avoid
|
|
40
|
-
|
|
41
|
-
- [ ] TBD
|
|
42
|
-
|
|
1
|
+
# Conventions
|
|
2
|
+
|
|
3
|
+
## Naming
|
|
4
|
+
|
|
5
|
+
- [ ] TBD
|
|
6
|
+
|
|
7
|
+
## Folders
|
|
8
|
+
|
|
9
|
+
- [ ] TBD
|
|
10
|
+
|
|
11
|
+
## Code Style
|
|
12
|
+
|
|
13
|
+
- [ ] TBD
|
|
14
|
+
|
|
15
|
+
## Error Handling
|
|
16
|
+
|
|
17
|
+
- [ ] TBD
|
|
18
|
+
|
|
19
|
+
## Logging
|
|
20
|
+
|
|
21
|
+
- [ ] TBD
|
|
22
|
+
|
|
23
|
+
## Testing
|
|
24
|
+
|
|
25
|
+
- [ ] TBD
|
|
26
|
+
|
|
27
|
+
## API
|
|
28
|
+
|
|
29
|
+
- [ ] TBD
|
|
30
|
+
|
|
31
|
+
## Security
|
|
32
|
+
|
|
33
|
+
- [ ] TBD
|
|
34
|
+
|
|
35
|
+
## Patterns To Follow
|
|
36
|
+
|
|
37
|
+
- [ ] TBD
|
|
38
|
+
|
|
39
|
+
## Patterns To Avoid
|
|
40
|
+
|
|
41
|
+
- [ ] TBD
|
|
42
|
+
|
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
# ADR: Title
|
|
2
|
-
|
|
3
|
-
Status: Proposed
|
|
4
|
-
Date:
|
|
5
|
-
|
|
6
|
-
## Context
|
|
7
|
-
|
|
8
|
-
TBD
|
|
9
|
-
|
|
10
|
-
## Decision
|
|
11
|
-
|
|
12
|
-
TBD
|
|
13
|
-
|
|
14
|
-
## Alternatives Considered
|
|
15
|
-
|
|
16
|
-
- [ ] TBD
|
|
17
|
-
|
|
18
|
-
## Consequences
|
|
19
|
-
|
|
20
|
-
- [ ] TBD
|
|
21
|
-
|
|
22
|
-
## Risks
|
|
23
|
-
|
|
24
|
-
- [ ] TBD
|
|
25
|
-
|
|
26
|
-
## Mitigation
|
|
27
|
-
|
|
28
|
-
- [ ] TBD
|
|
29
|
-
|
|
30
|
-
## Verification Evidence
|
|
31
|
-
|
|
32
|
-
TBD
|
|
33
|
-
|
|
1
|
+
# ADR: Title
|
|
2
|
+
|
|
3
|
+
Status: Proposed
|
|
4
|
+
Date:
|
|
5
|
+
|
|
6
|
+
## Context
|
|
7
|
+
|
|
8
|
+
TBD
|
|
9
|
+
|
|
10
|
+
## Decision
|
|
11
|
+
|
|
12
|
+
TBD
|
|
13
|
+
|
|
14
|
+
## Alternatives Considered
|
|
15
|
+
|
|
16
|
+
- [ ] TBD
|
|
17
|
+
|
|
18
|
+
## Consequences
|
|
19
|
+
|
|
20
|
+
- [ ] TBD
|
|
21
|
+
|
|
22
|
+
## Risks
|
|
23
|
+
|
|
24
|
+
- [ ] TBD
|
|
25
|
+
|
|
26
|
+
## Mitigation
|
|
27
|
+
|
|
28
|
+
- [ ] TBD
|
|
29
|
+
|
|
30
|
+
## Verification Evidence
|
|
31
|
+
|
|
32
|
+
TBD
|
|
33
|
+
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
# Design
|
|
2
|
-
|
|
3
|
-
## UX Principles
|
|
4
|
-
|
|
5
|
-
- [ ] TBD
|
|
6
|
-
|
|
7
|
-
## Screens / Pages
|
|
8
|
-
|
|
9
|
-
- [ ] TBD
|
|
10
|
-
|
|
11
|
-
## Component Conventions
|
|
12
|
-
|
|
13
|
-
- [ ] TBD
|
|
14
|
-
|
|
15
|
-
## State Management Rules
|
|
16
|
-
|
|
17
|
-
- [ ] TBD
|
|
18
|
-
|
|
19
|
-
## Accessibility Notes
|
|
20
|
-
|
|
21
|
-
- [ ] TBD
|
|
22
|
-
|
|
23
|
-
## Design Constraints
|
|
24
|
-
|
|
25
|
-
- [ ] TBD
|
|
26
|
-
|
|
1
|
+
# Design
|
|
2
|
+
|
|
3
|
+
## UX Principles
|
|
4
|
+
|
|
5
|
+
- [ ] TBD
|
|
6
|
+
|
|
7
|
+
## Screens / Pages
|
|
8
|
+
|
|
9
|
+
- [ ] TBD
|
|
10
|
+
|
|
11
|
+
## Component Conventions
|
|
12
|
+
|
|
13
|
+
- [ ] TBD
|
|
14
|
+
|
|
15
|
+
## State Management Rules
|
|
16
|
+
|
|
17
|
+
- [ ] TBD
|
|
18
|
+
|
|
19
|
+
## Accessibility Notes
|
|
20
|
+
|
|
21
|
+
- [ ] TBD
|
|
22
|
+
|
|
23
|
+
## Design Constraints
|
|
24
|
+
|
|
25
|
+
- [ ] TBD
|
|
26
|
+
|