gsd-codex-cli 1.20.0
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/.codex/prompts/gsd-add-phase.md +44 -0
- package/.codex/prompts/gsd-add-todo.md +43 -0
- package/.codex/prompts/gsd-audit-milestone.md +43 -0
- package/.codex/prompts/gsd-check-todos.md +43 -0
- package/.codex/prompts/gsd-complete-milestone.md +43 -0
- package/.codex/prompts/gsd-debug.md +46 -0
- package/.codex/prompts/gsd-discuss-phase.md +43 -0
- package/.codex/prompts/gsd-execute-phase.md +43 -0
- package/.codex/prompts/gsd-help.md +43 -0
- package/.codex/prompts/gsd-insert-phase.md +43 -0
- package/.codex/prompts/gsd-list-phase-assumptions.md +43 -0
- package/.codex/prompts/gsd-map-codebase.md +43 -0
- package/.codex/prompts/gsd-new-milestone.md +43 -0
- package/.codex/prompts/gsd-new-project.md +43 -0
- package/.codex/prompts/gsd-pause-work.md +43 -0
- package/.codex/prompts/gsd-plan-milestone-gaps.md +43 -0
- package/.codex/prompts/gsd-plan-phase.md +43 -0
- package/.codex/prompts/gsd-progress.md +43 -0
- package/.codex/prompts/gsd-quick.md +43 -0
- package/.codex/prompts/gsd-remove-phase.md +43 -0
- package/.codex/prompts/gsd-research-phase.md +43 -0
- package/.codex/prompts/gsd-resume-work.md +43 -0
- package/.codex/prompts/gsd-set-profile.md +43 -0
- package/.codex/prompts/gsd-settings.md +43 -0
- package/.codex/prompts/gsd-update.md +43 -0
- package/.codex/prompts/gsd-verify-work.md +43 -0
- package/.codex/skills/get-shit-done-codex/SKILL.md +65 -0
- package/.codex/skills/get-shit-done-codex/references/compat.md +32 -0
- package/.codex/skills/get-shit-done-codex/references/windows.md +23 -0
- package/CHANGELOG.md +1434 -0
- package/LICENSE +21 -0
- package/README.md +690 -0
- package/agents/gsd-codebase-mapper.md +761 -0
- package/agents/gsd-debugger.md +1198 -0
- package/agents/gsd-executor.md +419 -0
- package/agents/gsd-integration-checker.md +423 -0
- package/agents/gsd-phase-researcher.md +469 -0
- package/agents/gsd-plan-checker.md +622 -0
- package/agents/gsd-planner.md +1159 -0
- package/agents/gsd-project-researcher.md +618 -0
- package/agents/gsd-research-synthesizer.md +236 -0
- package/agents/gsd-roadmapper.md +639 -0
- package/agents/gsd-verifier.md +541 -0
- package/bin/install-codex.js +100 -0
- package/bin/install.js +1806 -0
- package/commands/gsd/add-phase.md +39 -0
- package/commands/gsd/add-todo.md +42 -0
- package/commands/gsd/audit-milestone.md +42 -0
- package/commands/gsd/check-todos.md +41 -0
- package/commands/gsd/cleanup.md +18 -0
- package/commands/gsd/complete-milestone.md +136 -0
- package/commands/gsd/debug.md +162 -0
- package/commands/gsd/discuss-phase.md +87 -0
- package/commands/gsd/execute-phase.md +42 -0
- package/commands/gsd/health.md +22 -0
- package/commands/gsd/help.md +22 -0
- package/commands/gsd/insert-phase.md +33 -0
- package/commands/gsd/join-discord.md +18 -0
- package/commands/gsd/list-phase-assumptions.md +50 -0
- package/commands/gsd/map-codebase.md +71 -0
- package/commands/gsd/new-milestone.md +51 -0
- package/commands/gsd/new-project.md +42 -0
- package/commands/gsd/pause-work.md +35 -0
- package/commands/gsd/plan-milestone-gaps.md +40 -0
- package/commands/gsd/plan-phase.md +44 -0
- package/commands/gsd/progress.md +24 -0
- package/commands/gsd/quick.md +40 -0
- package/commands/gsd/reapply-patches.md +110 -0
- package/commands/gsd/remove-phase.md +32 -0
- package/commands/gsd/research-phase.md +187 -0
- package/commands/gsd/resume-work.md +40 -0
- package/commands/gsd/set-profile.md +34 -0
- package/commands/gsd/settings.md +36 -0
- package/commands/gsd/update.md +37 -0
- package/commands/gsd/verify-work.md +39 -0
- package/get-shit-done/bin/gsd-tools.cjs +5243 -0
- package/get-shit-done/bin/gsd-tools.test.cjs +2273 -0
- package/get-shit-done/references/checkpoints.md +775 -0
- package/get-shit-done/references/continuation-format.md +249 -0
- package/get-shit-done/references/decimal-phase-calculation.md +65 -0
- package/get-shit-done/references/git-integration.md +248 -0
- package/get-shit-done/references/git-planning-commit.md +38 -0
- package/get-shit-done/references/model-profile-resolution.md +34 -0
- package/get-shit-done/references/model-profiles.md +92 -0
- package/get-shit-done/references/phase-argument-parsing.md +61 -0
- package/get-shit-done/references/planning-config.md +196 -0
- package/get-shit-done/references/questioning.md +145 -0
- package/get-shit-done/references/tdd.md +263 -0
- package/get-shit-done/references/ui-brand.md +160 -0
- package/get-shit-done/references/verification-patterns.md +612 -0
- package/get-shit-done/templates/DEBUG.md +159 -0
- package/get-shit-done/templates/UAT.md +247 -0
- package/get-shit-done/templates/codebase/architecture.md +255 -0
- package/get-shit-done/templates/codebase/concerns.md +310 -0
- package/get-shit-done/templates/codebase/conventions.md +307 -0
- package/get-shit-done/templates/codebase/integrations.md +280 -0
- package/get-shit-done/templates/codebase/stack.md +186 -0
- package/get-shit-done/templates/codebase/structure.md +285 -0
- package/get-shit-done/templates/codebase/testing.md +480 -0
- package/get-shit-done/templates/config.json +36 -0
- package/get-shit-done/templates/context.md +283 -0
- package/get-shit-done/templates/continue-here.md +78 -0
- package/get-shit-done/templates/debug-subagent-prompt.md +91 -0
- package/get-shit-done/templates/discovery.md +146 -0
- package/get-shit-done/templates/milestone-archive.md +123 -0
- package/get-shit-done/templates/milestone.md +115 -0
- package/get-shit-done/templates/phase-prompt.md +567 -0
- package/get-shit-done/templates/planner-subagent-prompt.md +117 -0
- package/get-shit-done/templates/project.md +184 -0
- package/get-shit-done/templates/requirements.md +231 -0
- package/get-shit-done/templates/research-project/ARCHITECTURE.md +204 -0
- package/get-shit-done/templates/research-project/FEATURES.md +147 -0
- package/get-shit-done/templates/research-project/PITFALLS.md +200 -0
- package/get-shit-done/templates/research-project/STACK.md +120 -0
- package/get-shit-done/templates/research-project/SUMMARY.md +170 -0
- package/get-shit-done/templates/research.md +552 -0
- package/get-shit-done/templates/roadmap.md +202 -0
- package/get-shit-done/templates/state.md +176 -0
- package/get-shit-done/templates/summary-complex.md +59 -0
- package/get-shit-done/templates/summary-minimal.md +41 -0
- package/get-shit-done/templates/summary-standard.md +48 -0
- package/get-shit-done/templates/summary.md +246 -0
- package/get-shit-done/templates/user-setup.md +311 -0
- package/get-shit-done/templates/verification-report.md +322 -0
- package/get-shit-done/workflows/add-phase.md +111 -0
- package/get-shit-done/workflows/add-todo.md +157 -0
- package/get-shit-done/workflows/audit-milestone.md +242 -0
- package/get-shit-done/workflows/check-todos.md +176 -0
- package/get-shit-done/workflows/cleanup.md +152 -0
- package/get-shit-done/workflows/complete-milestone.md +674 -0
- package/get-shit-done/workflows/diagnose-issues.md +219 -0
- package/get-shit-done/workflows/discovery-phase.md +289 -0
- package/get-shit-done/workflows/discuss-phase.md +485 -0
- package/get-shit-done/workflows/execute-phase.md +408 -0
- package/get-shit-done/workflows/execute-plan.md +441 -0
- package/get-shit-done/workflows/health.md +156 -0
- package/get-shit-done/workflows/help.md +486 -0
- package/get-shit-done/workflows/insert-phase.md +129 -0
- package/get-shit-done/workflows/list-phase-assumptions.md +178 -0
- package/get-shit-done/workflows/map-codebase.md +327 -0
- package/get-shit-done/workflows/new-milestone.md +373 -0
- package/get-shit-done/workflows/new-project.md +1113 -0
- package/get-shit-done/workflows/pause-work.md +122 -0
- package/get-shit-done/workflows/plan-milestone-gaps.md +256 -0
- package/get-shit-done/workflows/plan-phase.md +448 -0
- package/get-shit-done/workflows/progress.md +393 -0
- package/get-shit-done/workflows/quick.md +444 -0
- package/get-shit-done/workflows/remove-phase.md +154 -0
- package/get-shit-done/workflows/research-phase.md +74 -0
- package/get-shit-done/workflows/resume-project.md +306 -0
- package/get-shit-done/workflows/set-profile.md +80 -0
- package/get-shit-done/workflows/settings.md +200 -0
- package/get-shit-done/workflows/transition.md +539 -0
- package/get-shit-done/workflows/update.md +214 -0
- package/get-shit-done/workflows/verify-phase.md +242 -0
- package/get-shit-done/workflows/verify-work.md +570 -0
- package/hooks/dist/gsd-check-update.js +62 -0
- package/hooks/dist/gsd-statusline.js +91 -0
- package/package.json +54 -0
- package/scripts/build-hooks.js +42 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
# Roadmap Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/ROADMAP.md`.
|
|
4
|
+
|
|
5
|
+
## Initial Roadmap (v1.0 Greenfield)
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# Roadmap: [Project Name]
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
|
|
12
|
+
[One paragraph describing the journey from start to finish]
|
|
13
|
+
|
|
14
|
+
## Phases
|
|
15
|
+
|
|
16
|
+
**Phase Numbering:**
|
|
17
|
+
- Integer phases (1, 2, 3): Planned milestone work
|
|
18
|
+
- Decimal phases (2.1, 2.2): Urgent insertions (marked with INSERTED)
|
|
19
|
+
|
|
20
|
+
Decimal phases appear between their surrounding integers in numeric order.
|
|
21
|
+
|
|
22
|
+
- [ ] **Phase 1: [Name]** - [One-line description]
|
|
23
|
+
- [ ] **Phase 2: [Name]** - [One-line description]
|
|
24
|
+
- [ ] **Phase 3: [Name]** - [One-line description]
|
|
25
|
+
- [ ] **Phase 4: [Name]** - [One-line description]
|
|
26
|
+
|
|
27
|
+
## Phase Details
|
|
28
|
+
|
|
29
|
+
### Phase 1: [Name]
|
|
30
|
+
**Goal**: [What this phase delivers]
|
|
31
|
+
**Depends on**: Nothing (first phase)
|
|
32
|
+
**Requirements**: [REQ-01, REQ-02, REQ-03]
|
|
33
|
+
**Success Criteria** (what must be TRUE):
|
|
34
|
+
1. [Observable behavior from user perspective]
|
|
35
|
+
2. [Observable behavior from user perspective]
|
|
36
|
+
3. [Observable behavior from user perspective]
|
|
37
|
+
**Plans**: [Number of plans, e.g., "3 plans" or "TBD"]
|
|
38
|
+
|
|
39
|
+
Plans:
|
|
40
|
+
- [ ] 01-01: [Brief description of first plan]
|
|
41
|
+
- [ ] 01-02: [Brief description of second plan]
|
|
42
|
+
- [ ] 01-03: [Brief description of third plan]
|
|
43
|
+
|
|
44
|
+
### Phase 2: [Name]
|
|
45
|
+
**Goal**: [What this phase delivers]
|
|
46
|
+
**Depends on**: Phase 1
|
|
47
|
+
**Requirements**: [REQ-04, REQ-05]
|
|
48
|
+
**Success Criteria** (what must be TRUE):
|
|
49
|
+
1. [Observable behavior from user perspective]
|
|
50
|
+
2. [Observable behavior from user perspective]
|
|
51
|
+
**Plans**: [Number of plans]
|
|
52
|
+
|
|
53
|
+
Plans:
|
|
54
|
+
- [ ] 02-01: [Brief description]
|
|
55
|
+
- [ ] 02-02: [Brief description]
|
|
56
|
+
|
|
57
|
+
### Phase 2.1: Critical Fix (INSERTED)
|
|
58
|
+
**Goal**: [Urgent work inserted between phases]
|
|
59
|
+
**Depends on**: Phase 2
|
|
60
|
+
**Success Criteria** (what must be TRUE):
|
|
61
|
+
1. [What the fix achieves]
|
|
62
|
+
**Plans**: 1 plan
|
|
63
|
+
|
|
64
|
+
Plans:
|
|
65
|
+
- [ ] 02.1-01: [Description]
|
|
66
|
+
|
|
67
|
+
### Phase 3: [Name]
|
|
68
|
+
**Goal**: [What this phase delivers]
|
|
69
|
+
**Depends on**: Phase 2
|
|
70
|
+
**Requirements**: [REQ-06, REQ-07, REQ-08]
|
|
71
|
+
**Success Criteria** (what must be TRUE):
|
|
72
|
+
1. [Observable behavior from user perspective]
|
|
73
|
+
2. [Observable behavior from user perspective]
|
|
74
|
+
3. [Observable behavior from user perspective]
|
|
75
|
+
**Plans**: [Number of plans]
|
|
76
|
+
|
|
77
|
+
Plans:
|
|
78
|
+
- [ ] 03-01: [Brief description]
|
|
79
|
+
- [ ] 03-02: [Brief description]
|
|
80
|
+
|
|
81
|
+
### Phase 4: [Name]
|
|
82
|
+
**Goal**: [What this phase delivers]
|
|
83
|
+
**Depends on**: Phase 3
|
|
84
|
+
**Requirements**: [REQ-09, REQ-10]
|
|
85
|
+
**Success Criteria** (what must be TRUE):
|
|
86
|
+
1. [Observable behavior from user perspective]
|
|
87
|
+
2. [Observable behavior from user perspective]
|
|
88
|
+
**Plans**: [Number of plans]
|
|
89
|
+
|
|
90
|
+
Plans:
|
|
91
|
+
- [ ] 04-01: [Brief description]
|
|
92
|
+
|
|
93
|
+
## Progress
|
|
94
|
+
|
|
95
|
+
**Execution Order:**
|
|
96
|
+
Phases execute in numeric order: 2 → 2.1 → 2.2 → 3 → 3.1 → 4
|
|
97
|
+
|
|
98
|
+
| Phase | Plans Complete | Status | Completed |
|
|
99
|
+
|-------|----------------|--------|-----------|
|
|
100
|
+
| 1. [Name] | 0/3 | Not started | - |
|
|
101
|
+
| 2. [Name] | 0/2 | Not started | - |
|
|
102
|
+
| 3. [Name] | 0/2 | Not started | - |
|
|
103
|
+
| 4. [Name] | 0/1 | Not started | - |
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
<guidelines>
|
|
107
|
+
**Initial planning (v1.0):**
|
|
108
|
+
- Phase count depends on depth setting (quick: 3-5, standard: 5-8, comprehensive: 8-12)
|
|
109
|
+
- Each phase delivers something coherent
|
|
110
|
+
- Phases can have 1+ plans (split if >3 tasks or multiple subsystems)
|
|
111
|
+
- Plans use naming: {phase}-{plan}-PLAN.md (e.g., 01-02-PLAN.md)
|
|
112
|
+
- No time estimates (this isn't enterprise PM)
|
|
113
|
+
- Progress table updated by execute workflow
|
|
114
|
+
- Plan count can be "TBD" initially, refined during planning
|
|
115
|
+
|
|
116
|
+
**Success criteria:**
|
|
117
|
+
- 2-5 observable behaviors per phase (from user's perspective)
|
|
118
|
+
- Cross-checked against requirements during roadmap creation
|
|
119
|
+
- Flow downstream to `must_haves` in plan-phase
|
|
120
|
+
- Verified by verify-phase after execution
|
|
121
|
+
- Format: "User can [action]" or "[Thing] works/exists"
|
|
122
|
+
|
|
123
|
+
**After milestones ship:**
|
|
124
|
+
- Collapse completed milestones in `<details>` tags
|
|
125
|
+
- Add new milestone sections for upcoming work
|
|
126
|
+
- Keep continuous phase numbering (never restart at 01)
|
|
127
|
+
</guidelines>
|
|
128
|
+
|
|
129
|
+
<status_values>
|
|
130
|
+
- `Not started` - Haven't begun
|
|
131
|
+
- `In progress` - Currently working
|
|
132
|
+
- `Complete` - Done (add completion date)
|
|
133
|
+
- `Deferred` - Pushed to later (with reason)
|
|
134
|
+
</status_values>
|
|
135
|
+
|
|
136
|
+
## Milestone-Grouped Roadmap (After v1.0 Ships)
|
|
137
|
+
|
|
138
|
+
After completing first milestone, reorganize with milestone groupings:
|
|
139
|
+
|
|
140
|
+
```markdown
|
|
141
|
+
# Roadmap: [Project Name]
|
|
142
|
+
|
|
143
|
+
## Milestones
|
|
144
|
+
|
|
145
|
+
- ✅ **v1.0 MVP** - Phases 1-4 (shipped YYYY-MM-DD)
|
|
146
|
+
- 🚧 **v1.1 [Name]** - Phases 5-6 (in progress)
|
|
147
|
+
- 📋 **v2.0 [Name]** - Phases 7-10 (planned)
|
|
148
|
+
|
|
149
|
+
## Phases
|
|
150
|
+
|
|
151
|
+
<details>
|
|
152
|
+
<summary>✅ v1.0 MVP (Phases 1-4) - SHIPPED YYYY-MM-DD</summary>
|
|
153
|
+
|
|
154
|
+
### Phase 1: [Name]
|
|
155
|
+
**Goal**: [What this phase delivers]
|
|
156
|
+
**Plans**: 3 plans
|
|
157
|
+
|
|
158
|
+
Plans:
|
|
159
|
+
- [x] 01-01: [Brief description]
|
|
160
|
+
- [x] 01-02: [Brief description]
|
|
161
|
+
- [x] 01-03: [Brief description]
|
|
162
|
+
|
|
163
|
+
[... remaining v1.0 phases ...]
|
|
164
|
+
|
|
165
|
+
</details>
|
|
166
|
+
|
|
167
|
+
### 🚧 v1.1 [Name] (In Progress)
|
|
168
|
+
|
|
169
|
+
**Milestone Goal:** [What v1.1 delivers]
|
|
170
|
+
|
|
171
|
+
#### Phase 5: [Name]
|
|
172
|
+
**Goal**: [What this phase delivers]
|
|
173
|
+
**Depends on**: Phase 4
|
|
174
|
+
**Plans**: 2 plans
|
|
175
|
+
|
|
176
|
+
Plans:
|
|
177
|
+
- [ ] 05-01: [Brief description]
|
|
178
|
+
- [ ] 05-02: [Brief description]
|
|
179
|
+
|
|
180
|
+
[... remaining v1.1 phases ...]
|
|
181
|
+
|
|
182
|
+
### 📋 v2.0 [Name] (Planned)
|
|
183
|
+
|
|
184
|
+
**Milestone Goal:** [What v2.0 delivers]
|
|
185
|
+
|
|
186
|
+
[... v2.0 phases ...]
|
|
187
|
+
|
|
188
|
+
## Progress
|
|
189
|
+
|
|
190
|
+
| Phase | Milestone | Plans Complete | Status | Completed |
|
|
191
|
+
|-------|-----------|----------------|--------|-----------|
|
|
192
|
+
| 1. Foundation | v1.0 | 3/3 | Complete | YYYY-MM-DD |
|
|
193
|
+
| 2. Features | v1.0 | 2/2 | Complete | YYYY-MM-DD |
|
|
194
|
+
| 5. Security | v1.1 | 0/2 | Not started | - |
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
**Notes:**
|
|
198
|
+
- Milestone emoji: ✅ shipped, 🚧 in progress, 📋 planned
|
|
199
|
+
- Completed milestones collapsed in `<details>` for readability
|
|
200
|
+
- Current/future milestones expanded
|
|
201
|
+
- Continuous phase numbering (01-99)
|
|
202
|
+
- Progress table includes milestone column
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# State Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/STATE.md` — the project's living memory.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## File Template
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
# Project State
|
|
11
|
+
|
|
12
|
+
## Project Reference
|
|
13
|
+
|
|
14
|
+
See: .planning/PROJECT.md (updated [date])
|
|
15
|
+
|
|
16
|
+
**Core value:** [One-liner from PROJECT.md Core Value section]
|
|
17
|
+
**Current focus:** [Current phase name]
|
|
18
|
+
|
|
19
|
+
## Current Position
|
|
20
|
+
|
|
21
|
+
Phase: [X] of [Y] ([Phase name])
|
|
22
|
+
Plan: [A] of [B] in current phase
|
|
23
|
+
Status: [Ready to plan / Planning / Ready to execute / In progress / Phase complete]
|
|
24
|
+
Last activity: [YYYY-MM-DD] — [What happened]
|
|
25
|
+
|
|
26
|
+
Progress: [░░░░░░░░░░] 0%
|
|
27
|
+
|
|
28
|
+
## Performance Metrics
|
|
29
|
+
|
|
30
|
+
**Velocity:**
|
|
31
|
+
- Total plans completed: [N]
|
|
32
|
+
- Average duration: [X] min
|
|
33
|
+
- Total execution time: [X.X] hours
|
|
34
|
+
|
|
35
|
+
**By Phase:**
|
|
36
|
+
|
|
37
|
+
| Phase | Plans | Total | Avg/Plan |
|
|
38
|
+
|-------|-------|-------|----------|
|
|
39
|
+
| - | - | - | - |
|
|
40
|
+
|
|
41
|
+
**Recent Trend:**
|
|
42
|
+
- Last 5 plans: [durations]
|
|
43
|
+
- Trend: [Improving / Stable / Degrading]
|
|
44
|
+
|
|
45
|
+
*Updated after each plan completion*
|
|
46
|
+
|
|
47
|
+
## Accumulated Context
|
|
48
|
+
|
|
49
|
+
### Decisions
|
|
50
|
+
|
|
51
|
+
Decisions are logged in PROJECT.md Key Decisions table.
|
|
52
|
+
Recent decisions affecting current work:
|
|
53
|
+
|
|
54
|
+
- [Phase X]: [Decision summary]
|
|
55
|
+
- [Phase Y]: [Decision summary]
|
|
56
|
+
|
|
57
|
+
### Pending Todos
|
|
58
|
+
|
|
59
|
+
[From .planning/todos/pending/ — ideas captured during sessions]
|
|
60
|
+
|
|
61
|
+
None yet.
|
|
62
|
+
|
|
63
|
+
### Blockers/Concerns
|
|
64
|
+
|
|
65
|
+
[Issues that affect future work]
|
|
66
|
+
|
|
67
|
+
None yet.
|
|
68
|
+
|
|
69
|
+
## Session Continuity
|
|
70
|
+
|
|
71
|
+
Last session: [YYYY-MM-DD HH:MM]
|
|
72
|
+
Stopped at: [Description of last completed action]
|
|
73
|
+
Resume file: [Path to .continue-here*.md if exists, otherwise "None"]
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
<purpose>
|
|
77
|
+
|
|
78
|
+
STATE.md is the project's short-term memory spanning all phases and sessions.
|
|
79
|
+
|
|
80
|
+
**Problem it solves:** Information is captured in summaries, issues, and decisions but not systematically consumed. Sessions start without context.
|
|
81
|
+
|
|
82
|
+
**Solution:** A single, small file that's:
|
|
83
|
+
- Read first in every workflow
|
|
84
|
+
- Updated after every significant action
|
|
85
|
+
- Contains digest of accumulated context
|
|
86
|
+
- Enables instant session restoration
|
|
87
|
+
|
|
88
|
+
</purpose>
|
|
89
|
+
|
|
90
|
+
<lifecycle>
|
|
91
|
+
|
|
92
|
+
**Creation:** After ROADMAP.md is created (during init)
|
|
93
|
+
- Reference PROJECT.md (read it for current context)
|
|
94
|
+
- Initialize empty accumulated context sections
|
|
95
|
+
- Set position to "Phase 1 ready to plan"
|
|
96
|
+
|
|
97
|
+
**Reading:** First step of every workflow
|
|
98
|
+
- progress: Present status to user
|
|
99
|
+
- plan: Inform planning decisions
|
|
100
|
+
- execute: Know current position
|
|
101
|
+
- transition: Know what's complete
|
|
102
|
+
|
|
103
|
+
**Writing:** After every significant action
|
|
104
|
+
- execute: After SUMMARY.md created
|
|
105
|
+
- Update position (phase, plan, status)
|
|
106
|
+
- Note new decisions (detail in PROJECT.md)
|
|
107
|
+
- Add blockers/concerns
|
|
108
|
+
- transition: After phase marked complete
|
|
109
|
+
- Update progress bar
|
|
110
|
+
- Clear resolved blockers
|
|
111
|
+
- Refresh Project Reference date
|
|
112
|
+
|
|
113
|
+
</lifecycle>
|
|
114
|
+
|
|
115
|
+
<sections>
|
|
116
|
+
|
|
117
|
+
### Project Reference
|
|
118
|
+
Points to PROJECT.md for full context. Includes:
|
|
119
|
+
- Core value (the ONE thing that matters)
|
|
120
|
+
- Current focus (which phase)
|
|
121
|
+
- Last update date (triggers re-read if stale)
|
|
122
|
+
|
|
123
|
+
Claude reads PROJECT.md directly for requirements, constraints, and decisions.
|
|
124
|
+
|
|
125
|
+
### Current Position
|
|
126
|
+
Where we are right now:
|
|
127
|
+
- Phase X of Y — which phase
|
|
128
|
+
- Plan A of B — which plan within phase
|
|
129
|
+
- Status — current state
|
|
130
|
+
- Last activity — what happened most recently
|
|
131
|
+
- Progress bar — visual indicator of overall completion
|
|
132
|
+
|
|
133
|
+
Progress calculation: (completed plans) / (total plans across all phases) × 100%
|
|
134
|
+
|
|
135
|
+
### Performance Metrics
|
|
136
|
+
Track velocity to understand execution patterns:
|
|
137
|
+
- Total plans completed
|
|
138
|
+
- Average duration per plan
|
|
139
|
+
- Per-phase breakdown
|
|
140
|
+
- Recent trend (improving/stable/degrading)
|
|
141
|
+
|
|
142
|
+
Updated after each plan completion.
|
|
143
|
+
|
|
144
|
+
### Accumulated Context
|
|
145
|
+
|
|
146
|
+
**Decisions:** Reference to PROJECT.md Key Decisions table, plus recent decisions summary for quick access. Full decision log lives in PROJECT.md.
|
|
147
|
+
|
|
148
|
+
**Pending Todos:** Ideas captured via /gsd:add-todo
|
|
149
|
+
- Count of pending todos
|
|
150
|
+
- Reference to .planning/todos/pending/
|
|
151
|
+
- Brief list if few, count if many (e.g., "5 pending todos — see /gsd:check-todos")
|
|
152
|
+
|
|
153
|
+
**Blockers/Concerns:** From "Next Phase Readiness" sections
|
|
154
|
+
- Issues that affect future work
|
|
155
|
+
- Prefix with originating phase
|
|
156
|
+
- Cleared when addressed
|
|
157
|
+
|
|
158
|
+
### Session Continuity
|
|
159
|
+
Enables instant resumption:
|
|
160
|
+
- When was last session
|
|
161
|
+
- What was last completed
|
|
162
|
+
- Is there a .continue-here file to resume from
|
|
163
|
+
|
|
164
|
+
</sections>
|
|
165
|
+
|
|
166
|
+
<size_constraint>
|
|
167
|
+
|
|
168
|
+
Keep STATE.md under 100 lines.
|
|
169
|
+
|
|
170
|
+
It's a DIGEST, not an archive. If accumulated context grows too large:
|
|
171
|
+
- Keep only 3-5 recent decisions in summary (full log in PROJECT.md)
|
|
172
|
+
- Keep only active blockers, remove resolved ones
|
|
173
|
+
|
|
174
|
+
The goal is "read once, know where we are" — if it's too long, that fails.
|
|
175
|
+
|
|
176
|
+
</size_constraint>
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
---
|
|
2
|
+
phase: XX-name
|
|
3
|
+
plan: YY
|
|
4
|
+
subsystem: [primary category]
|
|
5
|
+
tags: [searchable tech]
|
|
6
|
+
requires:
|
|
7
|
+
- phase: [prior phase]
|
|
8
|
+
provides: [what that phase built]
|
|
9
|
+
provides:
|
|
10
|
+
- [bullet list of what was built/delivered]
|
|
11
|
+
affects: [list of phase names or keywords]
|
|
12
|
+
tech-stack:
|
|
13
|
+
added: [libraries/tools]
|
|
14
|
+
patterns: [architectural/code patterns]
|
|
15
|
+
key-files:
|
|
16
|
+
created: [important files created]
|
|
17
|
+
modified: [important files modified]
|
|
18
|
+
key-decisions:
|
|
19
|
+
- "Decision 1"
|
|
20
|
+
patterns-established:
|
|
21
|
+
- "Pattern 1: description"
|
|
22
|
+
duration: Xmin
|
|
23
|
+
completed: YYYY-MM-DD
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
# Phase [X]: [Name] Summary (Complex)
|
|
27
|
+
|
|
28
|
+
**[Substantive one-liner describing outcome]**
|
|
29
|
+
|
|
30
|
+
## Performance
|
|
31
|
+
- **Duration:** [time]
|
|
32
|
+
- **Tasks:** [count completed]
|
|
33
|
+
- **Files modified:** [count]
|
|
34
|
+
|
|
35
|
+
## Accomplishments
|
|
36
|
+
- [Key outcome 1]
|
|
37
|
+
- [Key outcome 2]
|
|
38
|
+
|
|
39
|
+
## Task Commits
|
|
40
|
+
1. **Task 1: [task name]** - `hash`
|
|
41
|
+
2. **Task 2: [task name]** - `hash`
|
|
42
|
+
3. **Task 3: [task name]** - `hash`
|
|
43
|
+
|
|
44
|
+
## Files Created/Modified
|
|
45
|
+
- `path/to/file.ts` - What it does
|
|
46
|
+
- `path/to/another.ts` - What it does
|
|
47
|
+
|
|
48
|
+
## Decisions Made
|
|
49
|
+
[Key decisions with brief rationale]
|
|
50
|
+
|
|
51
|
+
## Deviations from Plan (Auto-fixed)
|
|
52
|
+
[Detailed auto-fix records per GSD deviation rules]
|
|
53
|
+
|
|
54
|
+
## Issues Encountered
|
|
55
|
+
[Problems during planned work and resolutions]
|
|
56
|
+
|
|
57
|
+
## Next Phase Readiness
|
|
58
|
+
[What's ready for next phase]
|
|
59
|
+
[Blockers or concerns]
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
phase: XX-name
|
|
3
|
+
plan: YY
|
|
4
|
+
subsystem: [primary category]
|
|
5
|
+
tags: [searchable tech]
|
|
6
|
+
provides:
|
|
7
|
+
- [bullet list of what was built/delivered]
|
|
8
|
+
affects: [list of phase names or keywords]
|
|
9
|
+
tech-stack:
|
|
10
|
+
added: [libraries/tools]
|
|
11
|
+
patterns: [architectural/code patterns]
|
|
12
|
+
key-files:
|
|
13
|
+
created: [important files created]
|
|
14
|
+
modified: [important files modified]
|
|
15
|
+
key-decisions: []
|
|
16
|
+
duration: Xmin
|
|
17
|
+
completed: YYYY-MM-DD
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Phase [X]: [Name] Summary (Minimal)
|
|
21
|
+
|
|
22
|
+
**[Substantive one-liner describing outcome]**
|
|
23
|
+
|
|
24
|
+
## Performance
|
|
25
|
+
- **Duration:** [time]
|
|
26
|
+
- **Tasks:** [count]
|
|
27
|
+
- **Files modified:** [count]
|
|
28
|
+
|
|
29
|
+
## Accomplishments
|
|
30
|
+
- [Most important outcome]
|
|
31
|
+
- [Second key accomplishment]
|
|
32
|
+
|
|
33
|
+
## Task Commits
|
|
34
|
+
1. **Task 1: [task name]** - `hash`
|
|
35
|
+
2. **Task 2: [task name]** - `hash`
|
|
36
|
+
|
|
37
|
+
## Files Created/Modified
|
|
38
|
+
- `path/to/file.ts` - What it does
|
|
39
|
+
|
|
40
|
+
## Next Phase Readiness
|
|
41
|
+
[Ready for next phase]
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
phase: XX-name
|
|
3
|
+
plan: YY
|
|
4
|
+
subsystem: [primary category]
|
|
5
|
+
tags: [searchable tech]
|
|
6
|
+
provides:
|
|
7
|
+
- [bullet list of what was built/delivered]
|
|
8
|
+
affects: [list of phase names or keywords]
|
|
9
|
+
tech-stack:
|
|
10
|
+
added: [libraries/tools]
|
|
11
|
+
patterns: [architectural/code patterns]
|
|
12
|
+
key-files:
|
|
13
|
+
created: [important files created]
|
|
14
|
+
modified: [important files modified]
|
|
15
|
+
key-decisions:
|
|
16
|
+
- "Decision 1"
|
|
17
|
+
duration: Xmin
|
|
18
|
+
completed: YYYY-MM-DD
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
# Phase [X]: [Name] Summary
|
|
22
|
+
|
|
23
|
+
**[Substantive one-liner describing outcome]**
|
|
24
|
+
|
|
25
|
+
## Performance
|
|
26
|
+
- **Duration:** [time]
|
|
27
|
+
- **Tasks:** [count completed]
|
|
28
|
+
- **Files modified:** [count]
|
|
29
|
+
|
|
30
|
+
## Accomplishments
|
|
31
|
+
- [Key outcome 1]
|
|
32
|
+
- [Key outcome 2]
|
|
33
|
+
|
|
34
|
+
## Task Commits
|
|
35
|
+
1. **Task 1: [task name]** - `hash`
|
|
36
|
+
2. **Task 2: [task name]** - `hash`
|
|
37
|
+
3. **Task 3: [task name]** - `hash`
|
|
38
|
+
|
|
39
|
+
## Files Created/Modified
|
|
40
|
+
- `path/to/file.ts` - What it does
|
|
41
|
+
- `path/to/another.ts` - What it does
|
|
42
|
+
|
|
43
|
+
## Decisions & Deviations
|
|
44
|
+
[Key decisions or "None - followed plan as specified"]
|
|
45
|
+
[Minor deviations if any, or "None"]
|
|
46
|
+
|
|
47
|
+
## Next Phase Readiness
|
|
48
|
+
[What's ready for next phase]
|