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.
Files changed (178) hide show
  1. package/.codebase/ARCHITECTURE_REVIEW_COMPLETE.md +216 -216
  2. package/.codebase/CURRENT_STATE.md +8 -2
  3. package/.codebase/FILE_NAMING_CLARIFICATION.md +161 -161
  4. package/.codebase/HARNESS_COMPLETENESS_AUDIT.md +613 -613
  5. package/.codebase/IMPLEMENTATION_COMPLETE.md +429 -429
  6. package/.codebase/IMPLEMENTATION_HANDOFF.md +351 -351
  7. package/.codebase/IMPROVEMENTS_SUMMARY.md +419 -419
  8. package/.codebase/PHASE3_SKILLS_NAMING_COMPLETE.md +292 -292
  9. package/.codebase/PHASE_DEPENDENCY_MAP.md +486 -486
  10. package/.codebase/QUICK_START_SPEC_IMPACT.md +456 -456
  11. package/.codebase/README.md +139 -139
  12. package/.codebase/RECOVERY_POINTS.md +83 -438
  13. package/.codebase/beads.json +16 -0
  14. package/.codex/skills/genesis-ai-provider/SKILL.md +1 -1
  15. package/.codex/skills/genesis-api-contract/SKILL.md +1 -1
  16. package/.codex/skills/genesis-api-sync/SKILL.md +354 -354
  17. package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -101
  18. package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -257
  19. package/.codex/skills/genesis-architecture/SKILL.md +1 -1
  20. package/.codex/skills/genesis-codebase-map/SKILL.md +1 -1
  21. package/.codex/skills/genesis-debug-guide/SKILL.md +479 -479
  22. package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -339
  23. package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -210
  24. package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -158
  25. package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -365
  26. package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -289
  27. package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -288
  28. package/.codex/skills/genesis-design-spec/SKILL.md +3 -3
  29. package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -1003
  30. package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -359
  31. package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -312
  32. package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -382
  33. package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -851
  34. package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -491
  35. package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -187
  36. package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -297
  37. package/.codex/skills/genesis-harness/SKILL.md +1428 -1427
  38. package/.codex/skills/genesis-harness/agents/openai.yaml +7 -7
  39. package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -169
  40. package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -157
  41. package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -216
  42. package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -211
  43. package/.codex/skills/genesis-harness/references/planning-schema.md +35 -35
  44. package/.codex/skills/genesis-harness/references/quality-rubric.md +21 -21
  45. package/.codex/skills/genesis-harness/references/research-rubric.md +41 -41
  46. package/.codex/skills/genesis-harness/references/workflows.md +33 -33
  47. package/.codex/skills/genesis-harness/resources/agents-template.md +27 -27
  48. package/.codex/skills/genesis-harness/resources/api-docs-template.md +32 -32
  49. package/.codex/skills/genesis-harness/resources/architecture-template.md +30 -30
  50. package/.codex/skills/genesis-harness/resources/audit-template.md +26 -26
  51. package/.codex/skills/genesis-harness/resources/bug-template.md +34 -34
  52. package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -204
  53. package/.codex/skills/genesis-harness/resources/check-template.md +21 -21
  54. package/.codex/skills/genesis-harness/resources/conventions-template.md +42 -42
  55. package/.codex/skills/genesis-harness/resources/decision-template.md +33 -33
  56. package/.codex/skills/genesis-harness/resources/design-template.md +26 -26
  57. package/.codex/skills/genesis-harness/resources/escalation-template.md +21 -21
  58. package/.codex/skills/genesis-harness/resources/feature-template.md +49 -49
  59. package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -131
  60. package/.codex/skills/genesis-harness/resources/integrations-template.md +32 -32
  61. package/.codex/skills/genesis-harness/resources/journeys-template.md +13 -13
  62. package/.codex/skills/genesis-harness/resources/lessons-learned-template.md +12 -12
  63. package/.codex/skills/genesis-harness/resources/observability-template.md +34 -34
  64. package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -76
  65. package/.codex/skills/genesis-harness/resources/phase-template.md +34 -34
  66. package/.codex/skills/genesis-harness/resources/pitfalls-template.md +22 -22
  67. package/.codex/skills/genesis-harness/resources/planning-tree-template.md +39 -39
  68. package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -347
  69. package/.codex/skills/genesis-harness/resources/project-template.md +38 -38
  70. package/.codex/skills/genesis-harness/resources/quality-score-template.md +11 -11
  71. package/.codex/skills/genesis-harness/resources/requirements-template.md +26 -26
  72. package/.codex/skills/genesis-harness/resources/research-template.md +26 -26
  73. package/.codex/skills/genesis-harness/resources/review-template.md +22 -22
  74. package/.codex/skills/genesis-harness/resources/spec-changelog-template.md +6 -6
  75. package/.codex/skills/genesis-harness/resources/stack-template.md +33 -33
  76. package/.codex/skills/genesis-harness/resources/verification-template.md +26 -26
  77. package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +0 -0
  78. package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +0 -0
  79. package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +0 -0
  80. package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +0 -0
  81. package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +0 -0
  82. package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +0 -0
  83. package/.codex/skills/genesis-harness/scripts/compact-context.sh +0 -0
  84. package/.codex/skills/genesis-harness/scripts/create-adr.sh +0 -0
  85. package/.codex/skills/genesis-harness/scripts/create-bug.sh +0 -0
  86. package/.codex/skills/genesis-harness/scripts/create-feature.sh +0 -0
  87. package/.codex/skills/genesis-harness/scripts/detect-stack.sh +0 -0
  88. package/.codex/skills/genesis-harness/scripts/init-planning.sh +0 -0
  89. package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +0 -0
  90. package/.codex/skills/genesis-harness/scripts/offload-log.sh +0 -0
  91. package/.codex/skills/genesis-harness/scripts/run-verification.sh +0 -0
  92. package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +0 -0
  93. package/.codex/skills/genesis-harness/scripts/update-state.sh +0 -0
  94. package/.codex/skills/genesis-harness-engineering/SKILL.md +1 -1
  95. package/.codex/skills/genesis-new-design/SKILL.md +2 -1
  96. package/.codex/skills/genesis-new-design/agents/openai.yaml +3 -3
  97. package/.codex/skills/genesis-observability-automation/checklists/.gitkeep +0 -0
  98. package/.codex/skills/genesis-observability-automation/observability/.gitkeep +0 -0
  99. package/.codex/skills/genesis-observability-automation/playbooks/.gitkeep +0 -0
  100. package/.codex/skills/genesis-observability-automation/templates/.gitkeep +0 -0
  101. package/.codex/skills/genesis-pipeline-orchestration/SKILL.md +1 -1
  102. package/.codex/skills/genesis-planning/SKILL.md +26 -1
  103. package/.codex/skills/genesis-planning/checklists/mvp-readiness.md +18 -0
  104. package/.codex/skills/genesis-planning/examples/5-phase-roadmap-example.md +43 -0
  105. package/.codex/skills/genesis-planning/templates/phase-1-core.md +17 -0
  106. package/.codex/skills/genesis-planning/templates/phase-2-auth.md +17 -0
  107. package/.codex/skills/genesis-planning/templates/phase-3-features.md +17 -0
  108. package/.codex/skills/genesis-planning/templates/phase-4-integrations.md +17 -0
  109. package/.codex/skills/genesis-planning/templates/phase-5-readiness.md +17 -0
  110. package/.codex/skills/genesis-release/SKILL.md +24 -1
  111. package/.codex/skills/{genesis-release-orchestration → genesis-release}/checklists/post-deployment-verification.md +274 -274
  112. package/.codex/skills/{genesis-release-orchestration → genesis-release}/checklists/pre-release-validation.md +220 -220
  113. package/.codex/skills/{genesis-release-orchestration → genesis-release}/observability/release-tracking.md +253 -253
  114. package/.codex/skills/{genesis-release-orchestration → genesis-release}/playbooks/canary-deployment-orchestration.md +472 -472
  115. package/.codex/skills/{genesis-release-orchestration → genesis-release}/playbooks/semantic-versioning-automation.md +494 -494
  116. package/.codex/skills/{genesis-release-orchestration → genesis-release}/templates/deployment-strategy-template.md +303 -303
  117. package/.codex/skills/{genesis-release-orchestration → genesis-release}/templates/release-runbook-template.md +420 -420
  118. package/.codex/skills/genesis-research-first/SKILL.md +237 -237
  119. package/.codex/skills/genesis-research-first/templates/.gitkeep +0 -0
  120. package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -534
  121. package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -384
  122. package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -257
  123. package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -373
  124. package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -692
  125. package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -434
  126. package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -407
  127. package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/SKILL.md +1 -1
  128. package/.codex/skills/genesis-upgrade-design/agents/openai.yaml +3 -3
  129. package/.codex/skills/spec-impact-engine/SKILL.md +504 -504
  130. package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +0 -0
  131. package/.codex-plugin/plugin.json +19 -19
  132. package/CHANGELOG.md +56 -0
  133. package/LICENSE +22 -22
  134. package/README.EN.md +780 -730
  135. package/README.VI.md +772 -723
  136. package/README.md +102 -247
  137. package/VERSION +2 -2
  138. package/bin/genesis-harness.js +695 -92
  139. package/package.json +9 -3
  140. package/scripts/README.md +342 -342
  141. package/scripts/compact-context.sh +0 -0
  142. package/scripts/contract_integrity_gate.js +83 -0
  143. package/scripts/detect-changes.sh +0 -0
  144. package/scripts/healing_telemetry.js +118 -0
  145. package/scripts/install.sh +5 -6
  146. package/scripts/offload-log.sh +0 -0
  147. package/scripts/prompt_sentinel.js +84 -0
  148. package/scripts/run-evals.sh +20 -24
  149. package/scripts/run-verify-loop.sh +11 -0
  150. package/scripts/spec_visual_sync.js +157 -0
  151. package/scripts/test_generator.js +142 -0
  152. package/scripts/transition_state.sh +0 -0
  153. package/scripts/uninstall.sh +2 -5
  154. package/scripts/validation_gates.sh +40 -1
  155. package/scripts/verify.sh +6 -61
  156. package/tests/unit/contract_integrity_gate.test.js +74 -0
  157. package/tests/unit/healing_telemetry.test.js +58 -0
  158. package/tests/unit/prompt_sentinel.test.js +50 -0
  159. package/tests/unit/spec_visual_sync.test.js +77 -0
  160. package/tests/unit/test_generator.test.js +62 -0
  161. package/.codex/skills/genesis-docs/SKILL.md +0 -46
  162. package/.codex/skills/genesis-docs/agents/openai.yaml +0 -7
  163. package/.codex/skills/genesis-release-orchestration/SKILL.md +0 -653
  164. package/.codex/skills/genesis-release-orchestration/agents/openai.yaml +0 -7
  165. package/.codex/skills/genesis-research/SKILL.md +0 -46
  166. package/.codex/skills/genesis-research/agents/openai.yaml +0 -7
  167. /package/.codex/skills/{genesis-docs/checklists/checklist.md → genesis-docs-automation/checklists/manual-docs-checklist.md} +0 -0
  168. /package/.codex/skills/{genesis-docs/examples/example.md → genesis-docs-automation/examples/manual-docs-example.md} +0 -0
  169. /package/.codex/skills/{genesis-docs → genesis-docs-automation}/templates/docs-update-template.md +0 -0
  170. /package/.codex/skills/{genesis-state-machine/SKILL.md → genesis-harness/references/state-machine.md} +0 -0
  171. /package/.codex/skills/{genesis-release-orchestration/examples/example.md → genesis-release/examples/orchestration-example.md} +0 -0
  172. /package/.codex/skills/{genesis-research → genesis-research-first}/checklists/checklist.md +0 -0
  173. /package/.codex/skills/{genesis-research/examples/example.md → genesis-research-first/examples/manual-research-example.md} +0 -0
  174. /package/.codex/skills/{genesis-research → genesis-research-first}/templates/research-note-template.md +0 -0
  175. /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/agents/openai.yaml +0 -0
  176. /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/checklists/checklist.md +0 -0
  177. /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/examples/example.md +0 -0
  178. /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/templates/playwright-test-template.md +0 -0
@@ -1,21 +1,21 @@
1
- # Escalation
2
-
3
- Codex must stop and ask the user when:
4
-
5
- - [!] product requirement conflicts
6
- - [!] security decision is ambiguous
7
- - [!] public API breaking change is required
8
- - [!] destructive database migration is required
9
- - [!] credentials or secrets are missing
10
- - [!] cost/performance tradeoff is unclear
11
- - [!] legal/compliance concern exists
12
- - [!] user intent is ambiguous
13
- - [!] implementation would delete user data
14
- - [!] implementation requires paid external service setup
15
-
16
- ## Escalation Log
17
-
18
- | Date/Time | Reason | Decision Needed | Resolution |
19
- |---|---|---|---|
20
- | TBD | TBD | TBD | TBD |
21
-
1
+ # Escalation
2
+
3
+ Codex must stop and ask the user when:
4
+
5
+ - [!] product requirement conflicts
6
+ - [!] security decision is ambiguous
7
+ - [!] public API breaking change is required
8
+ - [!] destructive database migration is required
9
+ - [!] credentials or secrets are missing
10
+ - [!] cost/performance tradeoff is unclear
11
+ - [!] legal/compliance concern exists
12
+ - [!] user intent is ambiguous
13
+ - [!] implementation would delete user data
14
+ - [!] implementation requires paid external service setup
15
+
16
+ ## Escalation Log
17
+
18
+ | Date/Time | Reason | Decision Needed | Resolution |
19
+ |---|---|---|---|
20
+ | TBD | TBD | TBD | TBD |
21
+
@@ -1,49 +1,49 @@
1
- # Feature
2
-
3
- ## Summary
4
-
5
- TBD
6
-
7
- ## User Story
8
-
9
- As a TBD, I want TBD so that TBD.
10
-
11
- ## Expected Behavior
12
-
13
- - [ ] TBD
14
-
15
- ## Edge Cases
16
-
17
- - [ ] TBD
18
-
19
- ## Out Of Scope
20
-
21
- - [ ] TBD
22
-
23
- ## Acceptance Criteria
24
-
25
- - [ ] TBD
26
-
27
- ## Tasks
28
-
29
- - [ ] Read required planning docs
30
- - [ ] Read PITFALLS.md
31
- - [ ] Read LESSONS_LEARNED.md
32
- - [ ] Research existing codebase patterns
33
- - [ ] Research best practices
34
- - [ ] Create or update Mermaid diagram
35
- - [ ] Write SPEC.md
36
- - [ ] Write IMPACT.md
37
- - [ ] Write PLAN.md
38
- - [ ] Write TEST_CONTRACT.md
39
- - [ ] Add failing tests or verification
40
- - [ ] Implement feature
41
- - [ ] Run verification
42
- - [ ] Update docs
43
- - [ ] Review changed files
44
- - [ ] Remove unnecessary files/code
45
- - [ ] Update STATE.md
46
- - [ ] Update FEATURE_INDEX.md
47
- - [ ] Update SPEC_CHANGELOG.md
48
- - [ ] Mark completed tasks
49
-
1
+ # Feature
2
+
3
+ ## Summary
4
+
5
+ TBD
6
+
7
+ ## User Story
8
+
9
+ As a TBD, I want TBD so that TBD.
10
+
11
+ ## Expected Behavior
12
+
13
+ - [ ] TBD
14
+
15
+ ## Edge Cases
16
+
17
+ - [ ] TBD
18
+
19
+ ## Out Of Scope
20
+
21
+ - [ ] TBD
22
+
23
+ ## Acceptance Criteria
24
+
25
+ - [ ] TBD
26
+
27
+ ## Tasks
28
+
29
+ - [ ] Read required planning docs
30
+ - [ ] Read PITFALLS.md
31
+ - [ ] Read LESSONS_LEARNED.md
32
+ - [ ] Research existing codebase patterns
33
+ - [ ] Research best practices
34
+ - [ ] Create or update Mermaid diagram
35
+ - [ ] Write SPEC.md
36
+ - [ ] Write IMPACT.md
37
+ - [ ] Write PLAN.md
38
+ - [ ] Write TEST_CONTRACT.md
39
+ - [ ] Add failing tests or verification
40
+ - [ ] Implement feature
41
+ - [ ] Run verification
42
+ - [ ] Update docs
43
+ - [ ] Review changed files
44
+ - [ ] Remove unnecessary files/code
45
+ - [ ] Update STATE.md
46
+ - [ ] Update FEATURE_INDEX.md
47
+ - [ ] Update SPEC_CHANGELOG.md
48
+ - [ ] Mark completed tasks
49
+
@@ -1,131 +1,131 @@
1
- # Foundation Phase (Phase 0)
2
-
3
- ## Overview
4
-
5
- Phase 0 is a setup phase only. Its purpose is to complete project documentation and establish the planning framework.
6
-
7
- **This phase contains NO feature implementation tasks.**
8
-
9
- Feature phases (Phase 1, 2, 3...) are created later only after:
10
- - Requirements are finalized
11
- - Product roadmap is confirmed
12
- - Prioritization is decided
13
-
14
- ## Goal
15
-
16
- Establish complete project documentation, confirm product intent, and prepare for feature development.
17
-
18
- ## Scope
19
-
20
- - [x] Detect and extract project information
21
- - [ ] Complete PROJECT.md with confirmed details
22
- - [ ] Document all REQUIREMENTS.md
23
- - [ ] Define ARCHITECTURE.md based on codebase inspection
24
- - [ ] Document STACK.md (languages, frameworks, tools)
25
- - [ ] Define CONVENTIONS.md (coding patterns, style)
26
- - [ ] Document INTEGRATIONS.md (if any)
27
- - [ ] Create API_DOCS.md structure
28
- - [ ] Establish PITFALLS.md warnings
29
- - [ ] Create base Mermaid diagrams
30
- - [ ] Create initial QUALITY_SCORE.md
31
- - [ ] Verify harness is functional
32
-
33
- ## Tasks
34
-
35
- ### Read & Confirm
36
-
37
- - [ ] Read `.planning/PROJECT.md`
38
- - [ ] Confirm product intent is clear
39
- - [ ] Identify any missing requirements
40
-
41
- ### Document & Refine
42
-
43
- - [ ] Complete `.planning/REQUIREMENTS.md` with functional & non-functional reqs
44
- - [ ] Document `.planning/ARCHITECTURE.md` from codebase inspection
45
- - [ ] Complete `.planning/STACK.md` with full tech details
46
- - [ ] Document `.planning/CONVENTIONS.md` from existing code patterns
47
- - [ ] Identify pitfalls and document in `.planning/PITFALLS.md`
48
-
49
- ### Diagrams & References
50
-
51
- - [ ] Create `.planning/diagrams/system-context.mmd`
52
- - [ ] Create `.planning/diagrams/container-architecture.mmd`
53
- - [ ] Create `.planning/diagrams/database-erd.mmd` (if applicable)
54
- - [ ] Create `.planning/diagrams/deployment-flow.mmd`
55
-
56
- ### Quality & Verification
57
-
58
- - [ ] Initial QUALITY_SCORE.md (document current state)
59
- - [ ] Verify `.planning/` structure is complete
60
- - [ ] Verify all core docs have content (not just TBD)
61
- - [ ] Run any existing tests/builds to verify health
62
-
63
- ## Dependencies
64
-
65
- None. Phase 0 is the foundation.
66
-
67
- ## Acceptance Criteria
68
-
69
- - [x] `.planning/` structure created
70
- - [ ] PROJECT.md completed with confirmed product brief
71
- - [ ] REQUIREMENTS.md lists all known requirements
72
- - [ ] STACK.md documents all tech details
73
- - [ ] ARCHITECTURE.md describes system design
74
- - [ ] Diagrams are created and reasonably accurate
75
- - [ ] CONVENTIONS.md documents local patterns
76
- - [ ] No "TBD" remains in critical docs (PROJECT, REQUIREMENTS, STACK, ARCHITECTURE)
77
- - [ ] Team/user confirms they understand the roadmap and agree with scope
78
- - [ ] All verification checks pass
79
-
80
- ## Verification
81
-
82
- ```sh
83
- # Check structure exists
84
- ls -la .planning/phases/00-foundation/
85
- ls -la .planning/*.md
86
- ls -la .planning/diagrams/*.mmd
87
-
88
- # Verify no critical TBDs remain
89
- grep -l "TBD" .planning/PROJECT.md .planning/REQUIREMENTS.md .planning/STACK.md .planning/ARCHITECTURE.md || echo "✓ No TBDs in critical docs"
90
-
91
- # Run any project-specific verification
92
- # npm test
93
- # yarn lint
94
- # python -m pytest
95
- ```
96
-
97
- ## Next Phase
98
-
99
- After Foundation phase completes:
100
-
101
- 1. Create Phase 1 for first priority feature/milestone
102
- 2. Each phase gets its own numbered folder (01-feature-name, 02-feature-name, etc.)
103
- 3. Create feature-specific plans in `.planning/features/` as work begins
104
-
105
- ---
106
-
107
- ## Phase 0 vs Feature Phases
108
-
109
- **Phase 0 (Foundation):**
110
- - Documentation & setup
111
- - No feature work
112
- - Establishes framework
113
- - All docs defined but empty
114
-
115
- **Phase 1+ (Features):**
116
- - Implement specific features
117
- - Contain implementation tasks
118
- - Follow Foundation as blueprint
119
- - Created when requirements are clear
120
-
121
- ---
122
-
123
- ## Why No Feature Phases Initially?
124
-
125
- We don't know what users need until we:
126
- 1. Complete requirements
127
- 2. Research existing patterns
128
- 3. Validate assumptions
129
- 4. Prioritize work
130
-
131
- Phase 0 ensures we document existing state before planning future features.
1
+ # Foundation Phase (Phase 0)
2
+
3
+ ## Overview
4
+
5
+ Phase 0 is a setup phase only. Its purpose is to complete project documentation and establish the planning framework.
6
+
7
+ **This phase contains NO feature implementation tasks.**
8
+
9
+ Feature phases (Phase 1, 2, 3...) are created later only after:
10
+ - Requirements are finalized
11
+ - Product roadmap is confirmed
12
+ - Prioritization is decided
13
+
14
+ ## Goal
15
+
16
+ Establish complete project documentation, confirm product intent, and prepare for feature development.
17
+
18
+ ## Scope
19
+
20
+ - [x] Detect and extract project information
21
+ - [ ] Complete PROJECT.md with confirmed details
22
+ - [ ] Document all REQUIREMENTS.md
23
+ - [ ] Define ARCHITECTURE.md based on codebase inspection
24
+ - [ ] Document STACK.md (languages, frameworks, tools)
25
+ - [ ] Define CONVENTIONS.md (coding patterns, style)
26
+ - [ ] Document INTEGRATIONS.md (if any)
27
+ - [ ] Create API_DOCS.md structure
28
+ - [ ] Establish PITFALLS.md warnings
29
+ - [ ] Create base Mermaid diagrams
30
+ - [ ] Create initial QUALITY_SCORE.md
31
+ - [ ] Verify harness is functional
32
+
33
+ ## Tasks
34
+
35
+ ### Read & Confirm
36
+
37
+ - [ ] Read `.planning/PROJECT.md`
38
+ - [ ] Confirm product intent is clear
39
+ - [ ] Identify any missing requirements
40
+
41
+ ### Document & Refine
42
+
43
+ - [ ] Complete `.planning/REQUIREMENTS.md` with functional & non-functional reqs
44
+ - [ ] Document `.planning/ARCHITECTURE.md` from codebase inspection
45
+ - [ ] Complete `.planning/STACK.md` with full tech details
46
+ - [ ] Document `.planning/CONVENTIONS.md` from existing code patterns
47
+ - [ ] Identify pitfalls and document in `.planning/PITFALLS.md`
48
+
49
+ ### Diagrams & References
50
+
51
+ - [ ] Create `.planning/diagrams/system-context.mmd`
52
+ - [ ] Create `.planning/diagrams/container-architecture.mmd`
53
+ - [ ] Create `.planning/diagrams/database-erd.mmd` (if applicable)
54
+ - [ ] Create `.planning/diagrams/deployment-flow.mmd`
55
+
56
+ ### Quality & Verification
57
+
58
+ - [ ] Initial QUALITY_SCORE.md (document current state)
59
+ - [ ] Verify `.planning/` structure is complete
60
+ - [ ] Verify all core docs have content (not just TBD)
61
+ - [ ] Run any existing tests/builds to verify health
62
+
63
+ ## Dependencies
64
+
65
+ None. Phase 0 is the foundation.
66
+
67
+ ## Acceptance Criteria
68
+
69
+ - [x] `.planning/` structure created
70
+ - [ ] PROJECT.md completed with confirmed product brief
71
+ - [ ] REQUIREMENTS.md lists all known requirements
72
+ - [ ] STACK.md documents all tech details
73
+ - [ ] ARCHITECTURE.md describes system design
74
+ - [ ] Diagrams are created and reasonably accurate
75
+ - [ ] CONVENTIONS.md documents local patterns
76
+ - [ ] No "TBD" remains in critical docs (PROJECT, REQUIREMENTS, STACK, ARCHITECTURE)
77
+ - [ ] Team/user confirms they understand the roadmap and agree with scope
78
+ - [ ] All verification checks pass
79
+
80
+ ## Verification
81
+
82
+ ```sh
83
+ # Check structure exists
84
+ ls -la .planning/phases/00-foundation/
85
+ ls -la .planning/*.md
86
+ ls -la .planning/diagrams/*.mmd
87
+
88
+ # Verify no critical TBDs remain
89
+ grep -l "TBD" .planning/PROJECT.md .planning/REQUIREMENTS.md .planning/STACK.md .planning/ARCHITECTURE.md || echo "✓ No TBDs in critical docs"
90
+
91
+ # Run any project-specific verification
92
+ # npm test
93
+ # yarn lint
94
+ # python -m pytest
95
+ ```
96
+
97
+ ## Next Phase
98
+
99
+ After Foundation phase completes:
100
+
101
+ 1. Create Phase 1 for first priority feature/milestone
102
+ 2. Each phase gets its own numbered folder (01-feature-name, 02-feature-name, etc.)
103
+ 3. Create feature-specific plans in `.planning/features/` as work begins
104
+
105
+ ---
106
+
107
+ ## Phase 0 vs Feature Phases
108
+
109
+ **Phase 0 (Foundation):**
110
+ - Documentation & setup
111
+ - No feature work
112
+ - Establishes framework
113
+ - All docs defined but empty
114
+
115
+ **Phase 1+ (Features):**
116
+ - Implement specific features
117
+ - Contain implementation tasks
118
+ - Follow Foundation as blueprint
119
+ - Created when requirements are clear
120
+
121
+ ---
122
+
123
+ ## Why No Feature Phases Initially?
124
+
125
+ We don't know what users need until we:
126
+ 1. Complete requirements
127
+ 2. Research existing patterns
128
+ 3. Validate assumptions
129
+ 4. Prioritize work
130
+
131
+ Phase 0 ensures we document existing state before planning future features.
@@ -1,32 +1,32 @@
1
- # Integrations
2
-
3
- ## External Services
4
-
5
- - [ ] TBD
6
-
7
- ## SDKs / Packages
8
-
9
- - [ ] TBD
10
-
11
- ## Environment Variables
12
-
13
- | Name | Purpose | Required | Notes |
14
- |---|---|---:|---|
15
- | TBD | TBD | TBD | TBD |
16
-
17
- ## Secrets Required
18
-
19
- - [ ] TBD
20
-
21
- ## Failure Handling
22
-
23
- - [ ] TBD
24
-
25
- ## Fallback Behavior
26
-
27
- - [ ] TBD
28
-
29
- ## Rate Limits
30
-
31
- - [ ] TBD
32
-
1
+ # Integrations
2
+
3
+ ## External Services
4
+
5
+ - [ ] TBD
6
+
7
+ ## SDKs / Packages
8
+
9
+ - [ ] TBD
10
+
11
+ ## Environment Variables
12
+
13
+ | Name | Purpose | Required | Notes |
14
+ |---|---|---:|---|
15
+ | TBD | TBD | TBD | TBD |
16
+
17
+ ## Secrets Required
18
+
19
+ - [ ] TBD
20
+
21
+ ## Failure Handling
22
+
23
+ - [ ] TBD
24
+
25
+ ## Fallback Behavior
26
+
27
+ - [ ] TBD
28
+
29
+ ## Rate Limits
30
+
31
+ - [ ] TBD
32
+
@@ -1,13 +1,13 @@
1
- # Journeys
2
-
3
- ## Journey: TEMPLATE
4
-
5
- Steps:
6
- 1. TBD
7
-
8
- Expected UI:
9
- Expected API calls:
10
- Expected DB state:
11
- Expected logs:
12
- Verification command:
13
-
1
+ # Journeys
2
+
3
+ ## Journey: TEMPLATE
4
+
5
+ Steps:
6
+ 1. TBD
7
+
8
+ Expected UI:
9
+ Expected API calls:
10
+ Expected DB state:
11
+ Expected logs:
12
+ Verification command:
13
+
@@ -1,12 +1,12 @@
1
- # Lessons Learned
2
-
3
- ## Bug: TEMPLATE
4
-
5
- Date:
6
- Root cause:
7
- Failed assumption:
8
- Correct pattern:
9
- Prevention rule:
10
- Files changed:
11
- Verification:
12
-
1
+ # Lessons Learned
2
+
3
+ ## Bug: TEMPLATE
4
+
5
+ Date:
6
+ Root cause:
7
+ Failed assumption:
8
+ Correct pattern:
9
+ Prevention rule:
10
+ Files changed:
11
+ Verification:
12
+
@@ -1,34 +1,34 @@
1
- # Observability
2
-
3
- ## Logs
4
-
5
- - [ ] TBD
6
-
7
- ## Metrics
8
-
9
- - [ ] TBD
10
-
11
- ## Traces
12
-
13
- - [ ] TBD
14
-
15
- ## Error Reporting
16
-
17
- - [ ] TBD
18
-
19
- ## Health Checks
20
-
21
- - [ ] TBD
22
-
23
- ## Debug Commands
24
-
25
- ```sh
26
- # TBD
27
- ```
28
-
29
- ## Local Inspection Commands
30
-
31
- ```sh
32
- # TBD
33
- ```
34
-
1
+ # Observability
2
+
3
+ ## Logs
4
+
5
+ - [ ] TBD
6
+
7
+ ## Metrics
8
+
9
+ - [ ] TBD
10
+
11
+ ## Traces
12
+
13
+ - [ ] TBD
14
+
15
+ ## Error Reporting
16
+
17
+ - [ ] TBD
18
+
19
+ ## Health Checks
20
+
21
+ - [ ] TBD
22
+
23
+ ## Debug Commands
24
+
25
+ ```sh
26
+ # TBD
27
+ ```
28
+
29
+ ## Local Inspection Commands
30
+
31
+ ```sh
32
+ # TBD
33
+ ```
34
+