get-shit-done-cc 1.3.7 → 1.3.9
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/README.md +36 -0
- package/commands/gsd/new-project.md +105 -13
- package/commands/gsd/progress.md +1 -1
- package/get-shit-done/templates/project.md +128 -151
- package/get-shit-done/templates/state.md +61 -77
- package/get-shit-done/workflows/complete-milestone.md +229 -75
- package/get-shit-done/workflows/create-milestone.md +1 -1
- package/get-shit-done/workflows/create-roadmap.md +34 -23
- package/get-shit-done/workflows/resume-project.md +17 -8
- package/get-shit-done/workflows/transition.md +184 -126
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# State Template
|
|
2
2
|
|
|
3
|
-
Template for `.planning/STATE.md`
|
|
3
|
+
Template for `.planning/STATE.md` — the project's living memory.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -9,26 +9,19 @@ Template for `.planning/STATE.md` - the project's living memory.
|
|
|
9
9
|
```markdown
|
|
10
10
|
# Project State
|
|
11
11
|
|
|
12
|
-
## Project
|
|
13
|
-
[IMMUTABLE - Copy verbatim from PROJECT.md on creation. Never edit this section.]
|
|
12
|
+
## Project Reference
|
|
14
13
|
|
|
15
|
-
|
|
14
|
+
See: .planning/PROJECT.md (updated [date])
|
|
16
15
|
|
|
17
|
-
**Core
|
|
18
|
-
|
|
19
|
-
- [Requirement 2]
|
|
20
|
-
- [Requirement 3]
|
|
21
|
-
|
|
22
|
-
**Constraints:**
|
|
23
|
-
- [Key constraint 1]
|
|
24
|
-
- [Key constraint 2]
|
|
16
|
+
**Core value:** [One-liner from PROJECT.md Core Value section]
|
|
17
|
+
**Current focus:** [Current phase name]
|
|
25
18
|
|
|
26
19
|
## Current Position
|
|
27
20
|
|
|
28
21
|
Phase: [X] of [Y] ([Phase name])
|
|
29
22
|
Plan: [A] of [B] in current phase
|
|
30
23
|
Status: [Ready to plan / Planning / Ready to execute / In progress / Phase complete]
|
|
31
|
-
Last activity: [YYYY-MM-DD]
|
|
24
|
+
Last activity: [YYYY-MM-DD] — [What happened]
|
|
32
25
|
|
|
33
26
|
Progress: [░░░░░░░░░░] 0%
|
|
34
27
|
|
|
@@ -53,31 +46,26 @@ Progress: [░░░░░░░░░░] 0%
|
|
|
53
46
|
|
|
54
47
|
## Accumulated Context
|
|
55
48
|
|
|
56
|
-
### Decisions
|
|
49
|
+
### Decisions
|
|
50
|
+
|
|
51
|
+
Decisions are logged in PROJECT.md Key Decisions table.
|
|
52
|
+
Recent decisions affecting current work:
|
|
57
53
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
| - | - | - |
|
|
54
|
+
- [Phase X]: [Decision summary]
|
|
55
|
+
- [Phase Y]: [Decision summary]
|
|
61
56
|
|
|
62
57
|
### Deferred Issues
|
|
63
58
|
|
|
64
|
-
[From ISSUES.md
|
|
59
|
+
[From ISSUES.md — list open items with phase of origin]
|
|
65
60
|
|
|
66
61
|
None yet.
|
|
67
62
|
|
|
68
|
-
### Blockers/Concerns
|
|
63
|
+
### Blockers/Concerns
|
|
69
64
|
|
|
70
|
-
[
|
|
65
|
+
[Issues that affect future work]
|
|
71
66
|
|
|
72
67
|
None yet.
|
|
73
68
|
|
|
74
|
-
## Project Alignment
|
|
75
|
-
|
|
76
|
-
Last checked: [Date or "Project start"]
|
|
77
|
-
Status: [✓ Aligned / ⚠️ Drift detected / ✗ Misaligned]
|
|
78
|
-
Assessment: [One line summary]
|
|
79
|
-
Drift notes: [Details if drift detected, otherwise "None"]
|
|
80
|
-
|
|
81
69
|
## Session Continuity
|
|
82
70
|
|
|
83
71
|
Last session: [YYYY-MM-DD HH:MM]
|
|
@@ -86,25 +74,27 @@ Resume file: [Path to .continue-here*.md if exists, otherwise "None"]
|
|
|
86
74
|
```
|
|
87
75
|
|
|
88
76
|
<purpose>
|
|
89
|
-
STATE.md is the project's "short-term memory" that spans all phases and sessions.
|
|
90
77
|
|
|
91
|
-
|
|
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.
|
|
92
81
|
|
|
93
82
|
**Solution:** A single, small file that's:
|
|
94
|
-
-
|
|
95
|
-
-
|
|
96
|
-
- Contains digest of
|
|
97
|
-
- Enables instant
|
|
83
|
+
- Read first in every workflow
|
|
84
|
+
- Updated after every significant action
|
|
85
|
+
- Contains digest of accumulated context
|
|
86
|
+
- Enables instant session restoration
|
|
87
|
+
|
|
98
88
|
</purpose>
|
|
99
89
|
|
|
100
90
|
<lifecycle>
|
|
101
91
|
|
|
102
92
|
**Creation:** After ROADMAP.md is created (during init)
|
|
103
|
-
-
|
|
93
|
+
- Reference PROJECT.md (read it for current context)
|
|
104
94
|
- Initialize empty accumulated context sections
|
|
105
95
|
- Set position to "Phase 1 ready to plan"
|
|
106
96
|
|
|
107
|
-
**Reading:** First step of
|
|
97
|
+
**Reading:** First step of every workflow
|
|
108
98
|
- progress: Present status to user
|
|
109
99
|
- plan: Inform planning decisions
|
|
110
100
|
- execute: Know current position
|
|
@@ -113,30 +103,33 @@ STATE.md is the project's "short-term memory" that spans all phases and sessions
|
|
|
113
103
|
**Writing:** After every significant action
|
|
114
104
|
- execute: After SUMMARY.md created
|
|
115
105
|
- Update position (phase, plan, status)
|
|
116
|
-
-
|
|
117
|
-
-
|
|
118
|
-
-
|
|
106
|
+
- Note new decisions (detail in PROJECT.md)
|
|
107
|
+
- Update deferred issues list
|
|
108
|
+
- Add blockers/concerns
|
|
119
109
|
- transition: After phase marked complete
|
|
120
110
|
- Update progress bar
|
|
121
111
|
- Clear resolved blockers
|
|
122
|
-
-
|
|
123
|
-
- Update alignment status
|
|
112
|
+
- Refresh Project Reference date
|
|
124
113
|
|
|
125
114
|
</lifecycle>
|
|
126
115
|
|
|
127
116
|
<sections>
|
|
128
117
|
|
|
129
|
-
### Project
|
|
130
|
-
|
|
131
|
-
|
|
118
|
+
### Project Reference
|
|
119
|
+
Points to PROJECT.md for full context. Includes:
|
|
120
|
+
- Core value (the ONE thing that matters)
|
|
121
|
+
- Current focus (which phase)
|
|
122
|
+
- Last update date (triggers re-read if stale)
|
|
123
|
+
|
|
124
|
+
Claude reads PROJECT.md directly for requirements, constraints, and decisions.
|
|
132
125
|
|
|
133
126
|
### Current Position
|
|
134
127
|
Where we are right now:
|
|
135
|
-
- Phase X of Y
|
|
136
|
-
- Plan A of B
|
|
137
|
-
- Status
|
|
138
|
-
- Last activity
|
|
139
|
-
- Progress bar
|
|
128
|
+
- Phase X of Y — which phase
|
|
129
|
+
- Plan A of B — which plan within phase
|
|
130
|
+
- Status — current state
|
|
131
|
+
- Last activity — what happened most recently
|
|
132
|
+
- Progress bar — visual indicator of overall completion
|
|
140
133
|
|
|
141
134
|
Progress calculation: (completed plans) / (total plans across all phases) × 100%
|
|
142
135
|
|
|
@@ -151,10 +144,7 @@ Updated after each plan completion.
|
|
|
151
144
|
|
|
152
145
|
### Accumulated Context
|
|
153
146
|
|
|
154
|
-
**Decisions
|
|
155
|
-
- Extracted from SUMMARY.md "Decisions Made" sections
|
|
156
|
-
- Include phase number for traceability
|
|
157
|
-
- These constrain future phases (e.g., "use jose not jsonwebtoken")
|
|
147
|
+
**Decisions:** Reference to PROJECT.md Key Decisions table, plus recent decisions summary for quick access. Full decision log lives in PROJECT.md.
|
|
158
148
|
|
|
159
149
|
**Deferred Issues:** Open items from ISSUES.md
|
|
160
150
|
- Brief description with ISS-XXX number
|
|
@@ -167,14 +157,6 @@ Updated after each plan completion.
|
|
|
167
157
|
- Prefix with originating phase
|
|
168
158
|
- Cleared when addressed
|
|
169
159
|
|
|
170
|
-
### Project Alignment
|
|
171
|
-
Tracks whether work matches original requirements:
|
|
172
|
-
- ✓ Aligned: On track
|
|
173
|
-
- ⚠️ Drift: Scope creeping or diverging
|
|
174
|
-
- ✗ Misaligned: Work doesn't serve project goals
|
|
175
|
-
|
|
176
|
-
Updated after each phase completion.
|
|
177
|
-
|
|
178
160
|
### Session Continuity
|
|
179
161
|
Enables instant resumption:
|
|
180
162
|
- When was last session
|
|
@@ -184,43 +166,45 @@ Enables instant resumption:
|
|
|
184
166
|
</sections>
|
|
185
167
|
|
|
186
168
|
<size_constraint>
|
|
187
|
-
|
|
169
|
+
|
|
170
|
+
Keep STATE.md under 100 lines.
|
|
188
171
|
|
|
189
172
|
It's a DIGEST, not an archive. If accumulated context grows too large:
|
|
190
|
-
-
|
|
191
|
-
- Reference ISSUES.md instead of listing all: "12 open issues
|
|
192
|
-
- Keep only active blockers,
|
|
173
|
+
- Keep only 3-5 recent decisions in summary (full log in PROJECT.md)
|
|
174
|
+
- Reference ISSUES.md instead of listing all: "12 open issues — see ISSUES.md"
|
|
175
|
+
- Keep only active blockers, remove resolved ones
|
|
176
|
+
|
|
177
|
+
The goal is "read once, know where we are" — if it's too long, that fails.
|
|
193
178
|
|
|
194
|
-
The goal is "read once, know everything" - if it's too long, that fails.
|
|
195
179
|
</size_constraint>
|
|
196
180
|
|
|
197
181
|
<guidelines>
|
|
182
|
+
|
|
198
183
|
**When created:**
|
|
199
184
|
- During project initialization (after ROADMAP.md)
|
|
200
|
-
-
|
|
185
|
+
- Reference PROJECT.md (extract core value and current focus)
|
|
201
186
|
- Initialize empty sections
|
|
202
187
|
|
|
203
188
|
**When read:**
|
|
204
|
-
-
|
|
189
|
+
- Every workflow starts by reading STATE.md
|
|
190
|
+
- Then read PROJECT.md for full context
|
|
205
191
|
- Provides instant context restoration
|
|
206
|
-
- Shows current position and accumulated wisdom
|
|
207
192
|
|
|
208
193
|
**When updated:**
|
|
209
|
-
- After each plan execution (update position,
|
|
210
|
-
- After phase transitions (update progress bar, clear resolved blockers)
|
|
211
|
-
- After alignment checks (update alignment status)
|
|
194
|
+
- After each plan execution (update position, note decisions, update issues/blockers)
|
|
195
|
+
- After phase transitions (update progress bar, clear resolved blockers, refresh project reference)
|
|
212
196
|
|
|
213
197
|
**Size management:**
|
|
214
|
-
- Keep under
|
|
215
|
-
-
|
|
198
|
+
- Keep under 100 lines total
|
|
199
|
+
- Recent decisions only in STATE.md (full log in PROJECT.md)
|
|
216
200
|
- Reference ISSUES.md instead of listing all issues
|
|
217
|
-
- Keep only active blockers
|
|
201
|
+
- Keep only active blockers
|
|
218
202
|
|
|
219
203
|
**Sections:**
|
|
220
|
-
- Project
|
|
204
|
+
- Project Reference: Pointer to PROJECT.md with core value
|
|
221
205
|
- Current Position: Where we are now (phase, plan, status)
|
|
222
206
|
- Performance Metrics: Velocity tracking
|
|
223
|
-
- Accumulated Context:
|
|
224
|
-
- Project Alignment: Are we on track with original vision?
|
|
207
|
+
- Accumulated Context: Recent decisions, deferred issues, blockers
|
|
225
208
|
- Session Continuity: Resume information
|
|
209
|
+
|
|
226
210
|
</guidelines>
|