maxsimcli 5.0.6 → 5.1.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/README.md +316 -288
- package/dist/assets/CHANGELOG.md +14 -0
- package/dist/assets/hooks/maxsim-capture-learnings.cjs +128 -0
- package/dist/assets/hooks/maxsim-capture-learnings.cjs.map +1 -0
- package/dist/assets/hooks/maxsim-check-update.cjs +126 -88
- package/dist/assets/hooks/maxsim-check-update.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-notification-sound.cjs +87 -43
- package/dist/assets/hooks/maxsim-notification-sound.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-statusline.cjs +45 -171
- package/dist/assets/hooks/maxsim-statusline.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-stop-sound.cjs +86 -43
- package/dist/assets/hooks/maxsim-stop-sound.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-sync-reminder.cjs +72 -21
- package/dist/assets/hooks/maxsim-sync-reminder.cjs.map +1 -1
- package/dist/assets/templates/agents/AGENTS.md +62 -51
- package/dist/assets/templates/agents/executor.md +44 -59
- package/dist/assets/templates/agents/planner.md +36 -31
- package/dist/assets/templates/agents/researcher.md +35 -43
- package/dist/assets/templates/agents/verifier.md +29 -31
- package/dist/assets/templates/commands/maxsim/debug.md +20 -154
- package/dist/assets/templates/commands/maxsim/execute.md +19 -33
- package/dist/assets/templates/commands/maxsim/go.md +21 -20
- package/dist/assets/templates/commands/maxsim/help.md +5 -14
- package/dist/assets/templates/commands/maxsim/init.md +18 -40
- package/dist/assets/templates/commands/maxsim/plan.md +22 -37
- package/dist/assets/templates/commands/maxsim/progress.md +15 -16
- package/dist/assets/templates/commands/maxsim/quick.md +18 -29
- package/dist/assets/templates/commands/maxsim/settings.md +18 -26
- package/dist/assets/templates/references/continuation-format.md +2 -4
- package/dist/assets/templates/references/model-profiles.md +2 -2
- package/dist/assets/templates/references/planning-config.md +10 -11
- package/dist/assets/templates/references/self-improvement.md +120 -0
- package/dist/assets/templates/rules/conventions.md +1 -1
- package/dist/assets/templates/rules/verification-protocol.md +1 -1
- package/dist/assets/templates/skills/brainstorming/SKILL.md +35 -26
- package/dist/assets/templates/skills/code-review/SKILL.md +78 -55
- package/dist/assets/templates/skills/commit-conventions/SKILL.md +70 -36
- package/dist/assets/templates/skills/github-operations/SKILL.md +142 -0
- package/dist/assets/templates/skills/handoff-contract/SKILL.md +62 -28
- package/dist/assets/templates/skills/maxsim-batch/SKILL.md +68 -42
- package/dist/assets/templates/skills/maxsim-simplify/SKILL.md +65 -40
- package/dist/assets/templates/skills/project-memory/SKILL.md +121 -0
- package/dist/assets/templates/skills/research/SKILL.md +126 -0
- package/dist/assets/templates/skills/roadmap-writing/SKILL.md +71 -68
- package/dist/assets/templates/skills/systematic-debugging/SKILL.md +37 -25
- package/dist/assets/templates/skills/tdd/SKILL.md +36 -39
- package/dist/assets/templates/skills/using-maxsim/SKILL.md +69 -55
- package/dist/assets/templates/skills/verification/SKILL.md +167 -0
- package/dist/assets/templates/workflows/batch.md +249 -268
- package/dist/assets/templates/workflows/diagnose-issues.md +225 -151
- package/dist/assets/templates/workflows/execute-plan.md +191 -981
- package/dist/assets/templates/workflows/execute.md +350 -309
- package/dist/assets/templates/workflows/go.md +119 -138
- package/dist/assets/templates/workflows/health.md +71 -114
- package/dist/assets/templates/workflows/help.md +85 -147
- package/dist/assets/templates/workflows/init-existing.md +180 -1373
- package/dist/assets/templates/workflows/init.md +53 -165
- package/dist/assets/templates/workflows/new-milestone.md +91 -334
- package/dist/assets/templates/workflows/new-project.md +165 -1384
- package/dist/assets/templates/workflows/plan-create.md +182 -73
- package/dist/assets/templates/workflows/plan-discuss.md +89 -82
- package/dist/assets/templates/workflows/plan-research.md +191 -85
- package/dist/assets/templates/workflows/plan.md +122 -58
- package/dist/assets/templates/workflows/progress.md +76 -310
- package/dist/assets/templates/workflows/quick.md +70 -495
- package/dist/assets/templates/workflows/sdd.md +231 -221
- package/dist/assets/templates/workflows/settings.md +90 -120
- package/dist/assets/templates/workflows/verify-phase.md +296 -258
- package/dist/cli.cjs +17 -23465
- package/dist/cli.cjs.map +1 -1
- package/dist/install.cjs +356 -8358
- package/dist/install.cjs.map +1 -1
- package/package.json +16 -22
- package/dist/assets/templates/skills/agent-system-map/SKILL.md +0 -92
- package/dist/assets/templates/skills/evidence-collection/SKILL.md +0 -87
- package/dist/assets/templates/skills/github-artifact-protocol/SKILL.md +0 -67
- package/dist/assets/templates/skills/github-tools-guide/SKILL.md +0 -89
- package/dist/assets/templates/skills/input-validation/SKILL.md +0 -51
- package/dist/assets/templates/skills/memory-management/SKILL.md +0 -75
- package/dist/assets/templates/skills/research-methodology/SKILL.md +0 -137
- package/dist/assets/templates/skills/sdd/SKILL.md +0 -91
- package/dist/assets/templates/skills/tool-priority-guide/SKILL.md +0 -80
- package/dist/assets/templates/skills/verification-before-completion/SKILL.md +0 -71
- package/dist/assets/templates/skills/verification-gates/SKILL.md +0 -169
- package/dist/assets/templates/workflows/discuss-phase.md +0 -683
- package/dist/assets/templates/workflows/research-phase.md +0 -73
- package/dist/assets/templates/workflows/verify-work.md +0 -572
- package/dist/core-D5zUr9cb.cjs +0 -4305
- package/dist/core-D5zUr9cb.cjs.map +0 -1
- package/dist/skills-CjFWZIGM.cjs +0 -6824
- package/dist/skills-CjFWZIGM.cjs.map +0 -1
|
@@ -1,404 +1,161 @@
|
|
|
1
1
|
<purpose>
|
|
2
|
-
|
|
3
|
-
Start a new milestone cycle for an existing project. Loads project context, gathers milestone goals (from MILESTONE-CONTEXT.md or conversation), updates PROJECT.md and STATE.md, optionally runs parallel research, defines scoped requirements with REQ-IDs, spawns the roadmapper to create phased execution plan, and commits all artifacts. Brownfield equivalent of new-project.
|
|
4
|
-
|
|
2
|
+
Create a new GitHub Milestone with a structured phase breakdown. All state lives in GitHub Issues — no local planning files are created by this workflow.
|
|
5
3
|
</purpose>
|
|
6
4
|
|
|
7
|
-
<required_reading>
|
|
8
|
-
|
|
9
|
-
Read all files referenced by the invoking prompt's execution_context before starting.
|
|
10
|
-
|
|
11
|
-
</required_reading>
|
|
12
|
-
|
|
13
5
|
<process>
|
|
14
6
|
|
|
15
|
-
## 1
|
|
16
|
-
|
|
17
|
-
- Read PROJECT.md (existing project, validated requirements, decisions)
|
|
18
|
-
- Read MILESTONES.md (what shipped previously)
|
|
19
|
-
- Read STATE.md (blockers, decisions)
|
|
20
|
-
- Check for MILESTONE-CONTEXT.md (from /maxsim:plan)
|
|
21
|
-
|
|
22
|
-
## 2. Gather Milestone Goals
|
|
23
|
-
|
|
24
|
-
**If MILESTONE-CONTEXT.md exists:**
|
|
25
|
-
- Use features and scope from plan
|
|
26
|
-
- Present summary for confirmation
|
|
27
|
-
|
|
28
|
-
**If no context file:**
|
|
29
|
-
- Present what shipped in last milestone
|
|
30
|
-
- Ask: "What do you want to build next?"
|
|
31
|
-
- Use AskUserQuestion to explore features, priorities, constraints, scope
|
|
32
|
-
|
|
33
|
-
## 3. Determine Milestone Version
|
|
34
|
-
|
|
35
|
-
- Parse last version from MILESTONES.md
|
|
36
|
-
- Suggest next version (v1.0 → v1.1, or v2.0 for major)
|
|
37
|
-
- Confirm with user
|
|
38
|
-
|
|
39
|
-
## 4. Update PROJECT.md
|
|
40
|
-
|
|
41
|
-
Add/update:
|
|
7
|
+
## Step 1: Gather milestone details
|
|
42
8
|
|
|
43
|
-
|
|
44
|
-
## Current Milestone: v[X.Y] [Name]
|
|
9
|
+
Prompt user for milestone information:
|
|
45
10
|
|
|
46
|
-
**Goal:** [One sentence describing milestone focus]
|
|
47
|
-
|
|
48
|
-
**Target features:**
|
|
49
|
-
- [Feature 1]
|
|
50
|
-
- [Feature 2]
|
|
51
|
-
- [Feature 3]
|
|
52
11
|
```
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
12
|
+
AskUserQuestion([
|
|
13
|
+
{
|
|
14
|
+
header: "Milestone Name",
|
|
15
|
+
question: "What is the name of this milestone?",
|
|
16
|
+
followUp: "e.g. v2.0 Authentication, Q2 Dashboard, Payments MVP"
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
header: "Milestone Description",
|
|
20
|
+
question: "Describe the goal of this milestone in 1-2 sentences."
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
header: "Due Date",
|
|
24
|
+
question: "Due date? (YYYY-MM-DD or leave blank for none)"
|
|
25
|
+
}
|
|
26
|
+
])
|
|
65
27
|
```
|
|
66
28
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
## 6. Cleanup and Commit
|
|
29
|
+
Store as `$MILESTONE_NAME`, `$MILESTONE_DESCRIPTION`, `$MILESTONE_DUE`.
|
|
70
30
|
|
|
71
|
-
|
|
31
|
+
---
|
|
72
32
|
|
|
73
|
-
|
|
74
|
-
node ~/.claude/maxsim/bin/maxsim-tools.cjs commit "docs: start milestone v[X.Y] [Name]" --files .planning/PROJECT.md .planning/STATE.md
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
## 7. Load Context and Resolve Models
|
|
33
|
+
## Step 2: Create GitHub Milestone
|
|
78
34
|
|
|
79
35
|
```bash
|
|
80
|
-
|
|
36
|
+
node ~/.claude/maxsim/bin/maxsim-tools.cjs github create-milestone \
|
|
37
|
+
--title "$MILESTONE_NAME" \
|
|
38
|
+
--description "$MILESTONE_DESCRIPTION" \
|
|
39
|
+
--due-date "$MILESTONE_DUE"
|
|
81
40
|
```
|
|
82
41
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
## 8. Research Decision
|
|
86
|
-
|
|
87
|
-
AskUserQuestion: "Research the domain ecosystem for new features before defining requirements?"
|
|
88
|
-
- "Research first (Recommended)" — Discover patterns, features, architecture for NEW capabilities
|
|
89
|
-
- "Skip research" — Go straight to requirements
|
|
90
|
-
|
|
91
|
-
**Persist choice to config** (so future `/maxsim:plan` honors it):
|
|
42
|
+
Parse response for `$MILESTONE_NUMBER`.
|
|
92
43
|
|
|
93
|
-
|
|
94
|
-
# If "Research first": persist true
|
|
95
|
-
node ~/.claude/maxsim/bin/maxsim-tools.cjs config-set workflow.research true
|
|
96
|
-
|
|
97
|
-
# If "Skip research": persist false
|
|
98
|
-
node ~/.claude/maxsim/bin/maxsim-tools.cjs config-set workflow.research false
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
**If "Research first":**
|
|
44
|
+
Display:
|
|
102
45
|
|
|
103
46
|
```
|
|
104
47
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
105
|
-
MAXSIM ►
|
|
48
|
+
MAXSIM ► MILESTONE CREATED
|
|
106
49
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
107
50
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
51
|
+
Milestone #$MILESTONE_NUMBER: $MILESTONE_NAME
|
|
52
|
+
Description: $MILESTONE_DESCRIPTION
|
|
53
|
+
Due: $MILESTONE_DUE (or "No due date")
|
|
111
54
|
|
|
112
|
-
|
|
113
|
-
mkdir -p .planning/research
|
|
55
|
+
Now define the phases for this milestone.
|
|
114
56
|
```
|
|
115
57
|
|
|
116
|
-
|
|
58
|
+
---
|
|
117
59
|
|
|
118
|
-
|
|
119
|
-
```
|
|
120
|
-
Task(prompt="
|
|
121
|
-
<research_type>Project Research — {DIMENSION} for [new features].</research_type>
|
|
60
|
+
## Step 3: Get phase breakdown from user
|
|
122
61
|
|
|
123
|
-
|
|
124
|
-
SUBSEQUENT MILESTONE — Adding [target features] to existing app.
|
|
125
|
-
{EXISTING_CONTEXT}
|
|
126
|
-
Focus ONLY on what's needed for the NEW features.
|
|
127
|
-
</milestone_context>
|
|
62
|
+
Ask user to describe the phases:
|
|
128
63
|
|
|
129
|
-
<question>{QUESTION}</question>
|
|
130
|
-
|
|
131
|
-
<files_to_read>
|
|
132
|
-
- .planning/PROJECT.md (Project context)
|
|
133
|
-
</files_to_read>
|
|
134
|
-
|
|
135
|
-
<downstream_consumer>{CONSUMER}</downstream_consumer>
|
|
136
|
-
|
|
137
|
-
<quality_gate>{GATES}</quality_gate>
|
|
138
|
-
|
|
139
|
-
<output>
|
|
140
|
-
Write to: .planning/research/{FILE}
|
|
141
|
-
Use template: ~/.claude/maxsim/templates/research-project/{FILE}
|
|
142
|
-
</output>
|
|
143
|
-
", subagent_type="researcher", model="{researcher_model}", description="{DIMENSION} research")
|
|
144
64
|
```
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
| EXISTING_CONTEXT | Existing validated capabilities (DO NOT re-research): [from PROJECT.md] | Existing features (already built): [from PROJECT.md] | Existing architecture: [from PROJECT.md or codebase map] | Focus on common mistakes when ADDING these features to existing system |
|
|
151
|
-
| QUESTION | What stack additions/changes are needed for [new features]? | How do [target features] typically work? Expected behavior? | How do [target features] integrate with existing architecture? | Common mistakes when adding [target features] to [domain]? |
|
|
152
|
-
| CONSUMER | Specific libraries with versions for NEW capabilities, integration points, what NOT to add | Table stakes vs differentiators vs anti-features, complexity noted, dependencies on existing | Integration points, new components, data flow changes, suggested build order | Warning signs, prevention strategy, which phase should address it |
|
|
153
|
-
| GATES | Versions current (verify with Context7), rationale explains WHY, integration considered | Categories clear, complexity noted, dependencies identified | Integration points identified, new vs modified explicit, build order considers deps | Pitfalls specific to adding these features, integration pitfalls covered, prevention actionable |
|
|
154
|
-
| FILE | STACK.md | FEATURES.md | ARCHITECTURE.md | PITFALLS.md |
|
|
155
|
-
|
|
156
|
-
After all 4 complete, spawn synthesizer:
|
|
157
|
-
|
|
158
|
-
```
|
|
159
|
-
Task(prompt="
|
|
160
|
-
Synthesize research outputs into SUMMARY.md.
|
|
161
|
-
|
|
162
|
-
<files_to_read>
|
|
163
|
-
- .planning/research/STACK.md
|
|
164
|
-
- .planning/research/FEATURES.md
|
|
165
|
-
- .planning/research/ARCHITECTURE.md
|
|
166
|
-
- .planning/research/PITFALLS.md
|
|
167
|
-
</files_to_read>
|
|
168
|
-
|
|
169
|
-
Write to: .planning/research/SUMMARY.md
|
|
170
|
-
Use template: ~/.claude/maxsim/templates/research-project/SUMMARY.md
|
|
171
|
-
Commit after writing.
|
|
172
|
-
", subagent_type="researcher", model="{synthesizer_model}", description="Synthesize research")
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
Display key findings from SUMMARY.md:
|
|
176
|
-
```
|
|
177
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
178
|
-
MAXSIM ► RESEARCH COMPLETE ✓
|
|
179
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
180
|
-
|
|
181
|
-
**Stack additions:** [from SUMMARY.md]
|
|
182
|
-
**Feature table stakes:** [from SUMMARY.md]
|
|
183
|
-
**Watch Out For:** [from SUMMARY.md]
|
|
65
|
+
AskUserQuestion(
|
|
66
|
+
header: "Phase Breakdown",
|
|
67
|
+
question: "List the phases for this milestone. Provide each as: 'Phase Name: one-sentence goal'",
|
|
68
|
+
followUp: "Example:\nFoundation: Set up database schema and API layer\nUI: Build the core user interface\nIntegration: Connect frontend to backend APIs"
|
|
69
|
+
)
|
|
184
70
|
```
|
|
185
71
|
|
|
186
|
-
|
|
72
|
+
Parse the response into a list of `{ name, goal }` pairs.
|
|
187
73
|
|
|
188
|
-
|
|
74
|
+
Display parsed phases for confirmation:
|
|
189
75
|
|
|
190
76
|
```
|
|
191
|
-
|
|
192
|
-
MAXSIM ► DEFINING REQUIREMENTS
|
|
193
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
194
|
-
```
|
|
77
|
+
## Planned Phases
|
|
195
78
|
|
|
196
|
-
|
|
79
|
+
| # | Name | Goal |
|
|
80
|
+
|---|------|------|
|
|
81
|
+
| 1 | Foundation | Set up database schema and API layer |
|
|
82
|
+
| 2 | UI | Build the core user interface |
|
|
83
|
+
| 3 | Integration | Connect frontend to backend APIs |
|
|
197
84
|
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
Present features by category:
|
|
201
|
-
```
|
|
202
|
-
## [Category 1]
|
|
203
|
-
**Table stakes:** Feature A, Feature B
|
|
204
|
-
**Differentiators:** Feature C, Feature D
|
|
205
|
-
**Research notes:** [any relevant notes]
|
|
85
|
+
Are these phases correct?
|
|
206
86
|
```
|
|
207
87
|
|
|
208
|
-
**If no research:** Gather requirements through conversation. Ask: "What are the main things users need to do with [new features]?" Clarify, probe for related capabilities, group into categories.
|
|
209
|
-
|
|
210
|
-
**Scope each category** via AskUserQuestion (multiSelect: true, header max 12 chars):
|
|
211
|
-
- "[Feature 1]" — [brief description]
|
|
212
|
-
- "[Feature 2]" — [brief description]
|
|
213
|
-
- "None for this milestone" — Defer entire category
|
|
214
|
-
|
|
215
|
-
Track: Selected → this milestone. Unselected table stakes → future. Unselected differentiators → out of scope.
|
|
216
|
-
|
|
217
|
-
**Identify gaps** via AskUserQuestion:
|
|
218
|
-
- "No, research covered it" — Proceed
|
|
219
|
-
- "Yes, let me add some" — Capture additions
|
|
220
|
-
|
|
221
|
-
**Generate REQUIREMENTS.md:**
|
|
222
|
-
- v1 Requirements grouped by category (checkboxes, REQ-IDs)
|
|
223
|
-
- Future Requirements (deferred)
|
|
224
|
-
- Out of Scope (explicit exclusions with reasoning)
|
|
225
|
-
- Traceability section (empty, filled by roadmap)
|
|
226
|
-
|
|
227
|
-
**REQ-ID format:** `[CATEGORY]-[NUMBER]` (AUTH-01, NOTIF-02). Continue numbering from existing.
|
|
228
|
-
|
|
229
|
-
**Requirement quality criteria:**
|
|
230
|
-
|
|
231
|
-
Good requirements are:
|
|
232
|
-
- **Specific and testable:** "User can reset password via email link" (not "Handle password reset")
|
|
233
|
-
- **User-centric:** "User can X" (not "System does Y")
|
|
234
|
-
- **Atomic:** One capability per requirement (not "User can login and manage profile")
|
|
235
|
-
- **Independent:** Minimal dependencies on other requirements
|
|
236
|
-
|
|
237
|
-
Present FULL requirements list for confirmation:
|
|
238
|
-
|
|
239
88
|
```
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
Does this capture what you're building? (yes / adjust)
|
|
250
|
-
```
|
|
251
|
-
|
|
252
|
-
If "adjust": Return to scoping.
|
|
253
|
-
|
|
254
|
-
**Commit requirements:**
|
|
255
|
-
```bash
|
|
256
|
-
node ~/.claude/maxsim/bin/maxsim-tools.cjs commit "docs: define milestone v[X.Y] requirements" --files .planning/REQUIREMENTS.md
|
|
89
|
+
AskUserQuestion(
|
|
90
|
+
header: "Confirm Phases",
|
|
91
|
+
question: "Proceed with these phases?",
|
|
92
|
+
options: [
|
|
93
|
+
{ label: "Yes, create them" },
|
|
94
|
+
{ label: "No, let me revise" }
|
|
95
|
+
]
|
|
96
|
+
)
|
|
257
97
|
```
|
|
258
98
|
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
```
|
|
262
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
263
|
-
MAXSIM ► CREATING ROADMAP
|
|
264
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
99
|
+
If "No, let me revise": return to step 3 and re-prompt.
|
|
265
100
|
|
|
266
|
-
|
|
267
|
-
```
|
|
101
|
+
---
|
|
268
102
|
|
|
269
|
-
|
|
103
|
+
## Step 4: Create phase issues linked to milestone
|
|
270
104
|
|
|
271
|
-
|
|
272
|
-
Task(prompt="
|
|
273
|
-
<planning_context>
|
|
274
|
-
<files_to_read>
|
|
275
|
-
- .planning/PROJECT.md
|
|
276
|
-
- .planning/REQUIREMENTS.md
|
|
277
|
-
- .planning/research/SUMMARY.md (if exists)
|
|
278
|
-
- .planning/config.json
|
|
279
|
-
- .planning/MILESTONES.md
|
|
280
|
-
</files_to_read>
|
|
281
|
-
</planning_context>
|
|
282
|
-
|
|
283
|
-
<instructions>
|
|
284
|
-
Create roadmap for milestone v[X.Y]:
|
|
285
|
-
1. Start phase numbering from [N]
|
|
286
|
-
2. Derive phases from THIS MILESTONE's requirements only
|
|
287
|
-
3. Map every requirement to exactly one phase
|
|
288
|
-
4. Derive 2-5 success criteria per phase (observable user behaviors)
|
|
289
|
-
5. Validate 100% coverage
|
|
290
|
-
6. Write files immediately (ROADMAP.md, STATE.md, update REQUIREMENTS.md traceability)
|
|
291
|
-
7. Return ROADMAP CREATED with summary
|
|
292
|
-
|
|
293
|
-
Write files first, then return.
|
|
294
|
-
</instructions>
|
|
295
|
-
", subagent_type="planner", model="{roadmapper_model}", description="Create roadmap")
|
|
296
|
-
```
|
|
105
|
+
For each phase, run `github create-phase` sequentially:
|
|
297
106
|
|
|
298
|
-
**Handle return:**
|
|
299
|
-
|
|
300
|
-
**If `## ROADMAP BLOCKED`:** Present blocker, work with user, re-spawn.
|
|
301
|
-
|
|
302
|
-
**If `## ROADMAP CREATED`:** Read ROADMAP.md, present inline:
|
|
303
|
-
|
|
304
|
-
```
|
|
305
|
-
## Proposed Roadmap
|
|
306
|
-
|
|
307
|
-
**[N] phases** | **[X] requirements mapped** | All covered ✓
|
|
308
|
-
|
|
309
|
-
| # | Phase | Goal | Requirements | Success Criteria |
|
|
310
|
-
|---|-------|------|--------------|------------------|
|
|
311
|
-
| [N] | [Name] | [Goal] | [REQ-IDs] | [count] |
|
|
312
|
-
|
|
313
|
-
### Phase Details
|
|
314
|
-
|
|
315
|
-
**Phase [N]: [Name]**
|
|
316
|
-
Goal: [goal]
|
|
317
|
-
Requirements: [REQ-IDs]
|
|
318
|
-
Success criteria:
|
|
319
|
-
1. [criterion]
|
|
320
|
-
2. [criterion]
|
|
321
|
-
```
|
|
322
|
-
|
|
323
|
-
**Ask for approval** via AskUserQuestion:
|
|
324
|
-
- "Approve" — Commit and continue
|
|
325
|
-
- "Adjust phases" — Tell me what to change
|
|
326
|
-
- "Review full file" — Show raw ROADMAP.md
|
|
327
|
-
|
|
328
|
-
**If "Adjust":** Get notes, re-spawn roadmapper with revision context, loop until approved.
|
|
329
|
-
**If "Review":** Display raw ROADMAP.md, re-ask.
|
|
330
|
-
|
|
331
|
-
**Commit roadmap** (after approval):
|
|
332
107
|
```bash
|
|
333
|
-
|
|
334
|
-
```
|
|
335
|
-
|
|
336
|
-
## 10b. Create Phase Tracking Issues on GitHub
|
|
337
|
-
|
|
338
|
-
**This step is MANDATORY — GitHub Issues are the single source of truth for phase tracking.**
|
|
339
|
-
|
|
340
|
-
For each phase in the roadmap, run `github create-phase` to create a tracking issue:
|
|
341
|
-
|
|
342
|
-
```bash
|
|
343
|
-
# For each phase:
|
|
108
|
+
# For each phase (1-indexed):
|
|
344
109
|
node ~/.claude/maxsim/bin/maxsim-tools.cjs github create-phase \
|
|
345
110
|
--phase-number "[N]" \
|
|
346
111
|
--phase-name "[Phase Name]" \
|
|
347
|
-
--goal "[Phase Goal
|
|
112
|
+
--goal "[Phase Goal]" \
|
|
113
|
+
--milestone-number $MILESTONE_NUMBER
|
|
348
114
|
```
|
|
349
115
|
|
|
350
|
-
Track results. If any
|
|
116
|
+
Track results. If any creation fails, warn and provide the manual creation command.
|
|
351
117
|
|
|
352
|
-
|
|
353
|
-
|
|
118
|
+
After all phases are created, add each issue to the project board in the "To Do" column:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
node ~/.claude/maxsim/bin/maxsim-tools.cjs github move-issue \
|
|
122
|
+
--issue-number [ISSUE_NUM] \
|
|
123
|
+
--status "To Do"
|
|
354
124
|
```
|
|
355
125
|
|
|
356
|
-
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## Step 5: Display completion summary
|
|
357
129
|
|
|
358
130
|
```
|
|
359
131
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
360
|
-
MAXSIM ► MILESTONE
|
|
132
|
+
MAXSIM ► MILESTONE READY
|
|
361
133
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
362
134
|
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
| Artifact | Location |
|
|
366
|
-
|----------------|-----------------------------|
|
|
367
|
-
| Project | `.planning/PROJECT.md` |
|
|
368
|
-
| Research | `.planning/research/` |
|
|
369
|
-
| Requirements | `.planning/REQUIREMENTS.md` |
|
|
370
|
-
| Roadmap | `.planning/ROADMAP.md` |
|
|
371
|
-
| Phase Issues | GitHub Project Board |
|
|
372
|
-
|
|
373
|
-
**[N] phases** | **[X] requirements** | **[N] GitHub issues** | Ready to build ✓
|
|
135
|
+
Milestone #$MILESTONE_NUMBER: $MILESTONE_NAME
|
|
374
136
|
|
|
375
|
-
|
|
137
|
+
| # | Phase | Issue | Board Status |
|
|
138
|
+
|---|-------|-------|--------------|
|
|
139
|
+
| 1 | [Name] | #N | To Do |
|
|
140
|
+
| 2 | [Name] | #N | To Do |
|
|
141
|
+
| 3 | [Name] | #N | To Do |
|
|
376
142
|
|
|
377
|
-
|
|
143
|
+
All [N] phases created and added to the project board.
|
|
378
144
|
|
|
379
|
-
|
|
145
|
+
## Next Steps
|
|
380
146
|
|
|
381
|
-
|
|
147
|
+
Start planning the first phase:
|
|
382
148
|
|
|
383
|
-
|
|
149
|
+
/maxsim:plan 1 — begin discussion and planning for Phase 1
|
|
384
150
|
```
|
|
385
151
|
|
|
386
152
|
</process>
|
|
387
153
|
|
|
388
154
|
<success_criteria>
|
|
389
|
-
- [ ]
|
|
390
|
-
- [ ]
|
|
391
|
-
- [ ]
|
|
392
|
-
- [ ]
|
|
393
|
-
- [ ]
|
|
394
|
-
- [ ]
|
|
395
|
-
- [ ] planner (roadmap mode) spawned with phase numbering context
|
|
396
|
-
- [ ] Roadmap files written immediately (not draft)
|
|
397
|
-
- [ ] User feedback incorporated (if any)
|
|
398
|
-
- [ ] ROADMAP.md phases continue from previous milestone
|
|
399
|
-
- [ ] `github create-phase` called for every phase — all issues on GitHub board
|
|
400
|
-
- [ ] All commits made (if planning docs committed)
|
|
401
|
-
- [ ] User knows next step: `/maxsim:plan [N]`
|
|
402
|
-
|
|
403
|
-
**Atomic commits:** Each phase commits its artifacts immediately.
|
|
155
|
+
- [ ] User provides milestone name, description, and optional due date
|
|
156
|
+
- [ ] GitHub Milestone created via maxsim-tools
|
|
157
|
+
- [ ] User provides phase breakdown and confirms it
|
|
158
|
+
- [ ] Phase issues created and linked to the milestone
|
|
159
|
+
- [ ] All phase issues added to project board as "To Do"
|
|
160
|
+
- [ ] Summary displayed with issue numbers and next step
|
|
404
161
|
</success_criteria>
|