learnship 1.9.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/.claude-plugin/plugin.json +26 -0
- package/.cursor-plugin/plugin.json +26 -0
- package/LICENSE +21 -0
- package/README.md +791 -0
- package/SKILL.md +86 -0
- package/agents/debugger.md +102 -0
- package/agents/executor.md +115 -0
- package/agents/learnship-debugger.md +146 -0
- package/agents/learnship-executor.md +155 -0
- package/agents/learnship-phase-researcher.md +128 -0
- package/agents/learnship-plan-checker.md +119 -0
- package/agents/learnship-planner.md +146 -0
- package/agents/learnship-verifier.md +157 -0
- package/agents/planner.md +109 -0
- package/agents/researcher.md +80 -0
- package/agents/verifier.md +114 -0
- package/bin/install.js +1242 -0
- package/bin/learnship.js +56 -0
- package/commands/learnship/add-phase.md +22 -0
- package/commands/learnship/add-tests.md +24 -0
- package/commands/learnship/add-todo.md +21 -0
- package/commands/learnship/audit-milestone.md +21 -0
- package/commands/learnship/check-todos.md +22 -0
- package/commands/learnship/cleanup.md +22 -0
- package/commands/learnship/complete-milestone.md +22 -0
- package/commands/learnship/debug.md +27 -0
- package/commands/learnship/decision-log.md +22 -0
- package/commands/learnship/diagnose-issues.md +23 -0
- package/commands/learnship/discovery-phase.md +24 -0
- package/commands/learnship/discuss-milestone.md +23 -0
- package/commands/learnship/discuss-phase.md +23 -0
- package/commands/learnship/execute-phase.md +27 -0
- package/commands/learnship/execute-plan.md +26 -0
- package/commands/learnship/health.md +20 -0
- package/commands/learnship/help.md +19 -0
- package/commands/learnship/insert-phase.md +22 -0
- package/commands/learnship/knowledge-base.md +21 -0
- package/commands/learnship/list-phase-assumptions.md +21 -0
- package/commands/learnship/ls.md +20 -0
- package/commands/learnship/map-codebase.md +23 -0
- package/commands/learnship/milestone-retrospective.md +21 -0
- package/commands/learnship/new-milestone.md +23 -0
- package/commands/learnship/new-project.md +24 -0
- package/commands/learnship/next.md +22 -0
- package/commands/learnship/pause-work.md +21 -0
- package/commands/learnship/plan-milestone-gaps.md +22 -0
- package/commands/learnship/plan-phase.md +24 -0
- package/commands/learnship/progress.md +20 -0
- package/commands/learnship/quick.md +27 -0
- package/commands/learnship/reapply-patches.md +21 -0
- package/commands/learnship/release.md +21 -0
- package/commands/learnship/remove-phase.md +23 -0
- package/commands/learnship/research-phase.md +23 -0
- package/commands/learnship/resume-work.md +21 -0
- package/commands/learnship/set-profile.md +21 -0
- package/commands/learnship/settings.md +21 -0
- package/commands/learnship/transition.md +21 -0
- package/commands/learnship/update.md +21 -0
- package/commands/learnship/validate-phase.md +22 -0
- package/commands/learnship/verify-work.md +23 -0
- package/cursor-rules/learnship.mdc +60 -0
- package/gemini-extension.json +10 -0
- package/hooks/hooks-claude.json +15 -0
- package/hooks/hooks-cursor.json +10 -0
- package/hooks/session-start +43 -0
- package/install.sh +254 -0
- package/learnship/references/design-commands.md +119 -0
- package/learnship/references/git-integration.md +249 -0
- package/learnship/references/learning-design.md +142 -0
- package/learnship/references/model-profiles.md +90 -0
- package/learnship/references/planning-config.md +184 -0
- package/learnship/references/questioning.md +162 -0
- package/learnship/references/ui-brand.md +160 -0
- package/learnship/references/verification-patterns.md +608 -0
- package/learnship/templates/agents.md +166 -0
- package/learnship/templates/context.md +72 -0
- package/learnship/templates/plan.md +202 -0
- package/learnship/templates/project.md +184 -0
- package/learnship/templates/requirements.md +231 -0
- package/learnship/templates/state.md +176 -0
- package/learnship/templates/uat.md +80 -0
- package/learnship/workflows/add-phase.md +84 -0
- package/learnship/workflows/add-tests.md +191 -0
- package/learnship/workflows/add-todo.md +108 -0
- package/learnship/workflows/audit-milestone.md +178 -0
- package/learnship/workflows/check-todos.md +138 -0
- package/learnship/workflows/cleanup.md +107 -0
- package/learnship/workflows/complete-milestone.md +191 -0
- package/learnship/workflows/debug.md +245 -0
- package/learnship/workflows/decision-log.md +131 -0
- package/learnship/workflows/diagnose-issues.md +145 -0
- package/learnship/workflows/discovery-phase.md +183 -0
- package/learnship/workflows/discuss-milestone.md +136 -0
- package/learnship/workflows/discuss-phase.md +244 -0
- package/learnship/workflows/execute-phase.md +345 -0
- package/learnship/workflows/execute-plan.md +149 -0
- package/learnship/workflows/health.md +171 -0
- package/learnship/workflows/help.md +153 -0
- package/learnship/workflows/insert-phase.md +106 -0
- package/learnship/workflows/knowledge-base.md +168 -0
- package/learnship/workflows/list-phase-assumptions.md +129 -0
- package/learnship/workflows/ls.md +145 -0
- package/learnship/workflows/map-codebase.md +142 -0
- package/learnship/workflows/milestone-retrospective.md +178 -0
- package/learnship/workflows/new-milestone.md +200 -0
- package/learnship/workflows/new-project.md +340 -0
- package/learnship/workflows/next.md +100 -0
- package/learnship/workflows/pause-work.md +122 -0
- package/learnship/workflows/plan-milestone-gaps.md +160 -0
- package/learnship/workflows/plan-phase.md +288 -0
- package/learnship/workflows/progress.md +118 -0
- package/learnship/workflows/quick.md +256 -0
- package/learnship/workflows/reapply-patches.md +130 -0
- package/learnship/workflows/release.md +217 -0
- package/learnship/workflows/remove-phase.md +128 -0
- package/learnship/workflows/research-phase.md +137 -0
- package/learnship/workflows/resume-work.md +162 -0
- package/learnship/workflows/set-profile.md +78 -0
- package/learnship/workflows/settings.md +204 -0
- package/learnship/workflows/sync-upstream-skills.md +269 -0
- package/learnship/workflows/transition.md +165 -0
- package/learnship/workflows/update.md +166 -0
- package/learnship/workflows/validate-phase.md +174 -0
- package/learnship/workflows/verify-work.md +264 -0
- package/package.json +62 -0
- package/references/design-commands.md +119 -0
- package/references/git-integration.md +249 -0
- package/references/learning-design.md +142 -0
- package/references/model-profiles.md +90 -0
- package/references/planning-config.md +184 -0
- package/references/questioning.md +162 -0
- package/references/ui-brand.md +160 -0
- package/references/verification-patterns.md +608 -0
- package/skills/agentic-learning/SKILL.md +373 -0
- package/skills/agentic-learning/references/either-or-format.md +161 -0
- package/skills/agentic-learning/references/learning-science.md +190 -0
- package/skills/agentic-learning/references/struggle-ladder.md +140 -0
- package/skills/impeccable/SKILL.md +125 -0
- package/skills/impeccable/adapt/SKILL.md +199 -0
- package/skills/impeccable/animate/SKILL.md +190 -0
- package/skills/impeccable/audit/SKILL.md +129 -0
- package/skills/impeccable/bolder/SKILL.md +132 -0
- package/skills/impeccable/clarify/SKILL.md +180 -0
- package/skills/impeccable/colorize/SKILL.md +158 -0
- package/skills/impeccable/critique/SKILL.md +118 -0
- package/skills/impeccable/delight/SKILL.md +317 -0
- package/skills/impeccable/distill/SKILL.md +137 -0
- package/skills/impeccable/extract/SKILL.md +95 -0
- package/skills/impeccable/frontend-design/SKILL.md +127 -0
- package/skills/impeccable/frontend-design/reference/color-and-contrast.md +132 -0
- package/skills/impeccable/frontend-design/reference/interaction-design.md +123 -0
- package/skills/impeccable/frontend-design/reference/motion-design.md +99 -0
- package/skills/impeccable/frontend-design/reference/responsive-design.md +114 -0
- package/skills/impeccable/frontend-design/reference/spatial-design.md +100 -0
- package/skills/impeccable/frontend-design/reference/typography.md +131 -0
- package/skills/impeccable/frontend-design/reference/ux-writing.md +107 -0
- package/skills/impeccable/harden/SKILL.md +358 -0
- package/skills/impeccable/normalize/SKILL.md +67 -0
- package/skills/impeccable/onboard/SKILL.md +243 -0
- package/skills/impeccable/optimize/SKILL.md +269 -0
- package/skills/impeccable/polish/SKILL.md +202 -0
- package/skills/impeccable/quieter/SKILL.md +118 -0
- package/skills/impeccable/teach-impeccable/SKILL.md +69 -0
- package/templates/agents.md +166 -0
- package/templates/config.json +22 -0
- package/templates/context.md +72 -0
- package/templates/plan.md +202 -0
- package/templates/project.md +184 -0
- package/templates/requirements.md +231 -0
- package/templates/state.md +176 -0
- package/templates/uat.md +80 -0
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# Learning × Design Integration
|
|
2
|
+
|
|
3
|
+
How to use the Learning Partner and Design System together. These two layers amplify each other when used at the right moments.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## The Core Idea
|
|
8
|
+
|
|
9
|
+
Building software teaches you things. Building *interfaces* teaches you even more — because design decisions are high-stakes, visible, and often irreversible once shipped. The Learning Partner captures that knowledge before it evaporates.
|
|
10
|
+
|
|
11
|
+
The pattern:
|
|
12
|
+
1. **Before design** — brainstorm to surface blind spots
|
|
13
|
+
2. **During design** — use steering commands to maintain quality
|
|
14
|
+
3. **After design** — reflect to consolidate what you learned
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Before Any Design Work
|
|
19
|
+
|
|
20
|
+
### Start with brainstorm
|
|
21
|
+
|
|
22
|
+
Before writing a line of UI code, use:
|
|
23
|
+
```
|
|
24
|
+
@agentic-learning brainstorm [interface or feature name]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
This surfaces:
|
|
28
|
+
- What problem does this UI solve? For whom?
|
|
29
|
+
- What mental model does the user have coming in?
|
|
30
|
+
- What are the 2-3 approaches? What are the trade-offs?
|
|
31
|
+
- What's the one thing they'll remember about this interface?
|
|
32
|
+
|
|
33
|
+
The brainstorm is saved to `docs/brainstorm/` — it becomes a design brief that both the agent and you can reference.
|
|
34
|
+
|
|
35
|
+
### Use either-or to log design decisions
|
|
36
|
+
|
|
37
|
+
When you choose between two approaches (card layout vs. table, modal vs. inline edit, sidebar vs. tabs), log it:
|
|
38
|
+
```
|
|
39
|
+
@agentic-learning either-or
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
This creates a decision journal entry — paths considered, the choice, the rationale. When you revisit the design in 3 weeks and wonder "why did we do it this way?", the journal has the answer.
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## During Design Sprints
|
|
47
|
+
|
|
48
|
+
### Use steering commands to maintain quality
|
|
49
|
+
|
|
50
|
+
While building interfaces, invoke design steering commands directly:
|
|
51
|
+
|
|
52
|
+
| Moment | Command |
|
|
53
|
+
|--------|---------|
|
|
54
|
+
| Before starting any new component | `/audit` — check what quality problems to avoid |
|
|
55
|
+
| After first pass of implementation | `/critique` — get honest feedback before polish |
|
|
56
|
+
| Typography looks off | `/typography` — systematic type review |
|
|
57
|
+
| Colors feel wrong | `/color` — OKLCH-based palette review |
|
|
58
|
+
| Layout feels cramped or cluttered | `/layout` — spatial rhythm review |
|
|
59
|
+
| Adding animations | `/motion` — purposeful motion, not decoration |
|
|
60
|
+
| Building forms | `/forms` — labels, validation, error states |
|
|
61
|
+
| Writing button labels or headings | `/copy` — UX writing review |
|
|
62
|
+
| Worried about accessibility | `/accessibility` — focus, contrast, screen readers |
|
|
63
|
+
|
|
64
|
+
### The AI Slop Test
|
|
65
|
+
|
|
66
|
+
Run `/critique` and ask: "If someone saw this and said 'AI made this' — would they be right?"
|
|
67
|
+
|
|
68
|
+
If yes, that's the signal to push harder. Use `@agentic-learning struggle` to work through it yourself first:
|
|
69
|
+
```
|
|
70
|
+
@agentic-learning struggle "make this interface feel genuinely designed, not AI-generated"
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
This forces you to try your own design thinking before getting a solution — which builds the design intuition that transfers to the next project.
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## After Design Phases
|
|
78
|
+
|
|
79
|
+
### Reflect after execute-phase
|
|
80
|
+
|
|
81
|
+
When a UI phase finishes executing:
|
|
82
|
+
```
|
|
83
|
+
@agentic-learning reflect
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Three questions:
|
|
87
|
+
1. What design decisions did you make? Which ones felt right?
|
|
88
|
+
2. What were you trying to achieve aesthetically and functionally?
|
|
89
|
+
3. What's still fuzzy — patterns you used but don't fully understand?
|
|
90
|
+
|
|
91
|
+
### Schedule design patterns for review
|
|
92
|
+
|
|
93
|
+
After a design-heavy phase:
|
|
94
|
+
```
|
|
95
|
+
@agentic-learning space
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
This schedules the design patterns you used (OKLCH color, container queries, motion easing, etc.) for spaced review — so they transfer to long-term memory instead of being forgotten between projects.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Learning Design Patterns Explicitly
|
|
103
|
+
|
|
104
|
+
When you encounter a design pattern you want to understand deeply (not just copy):
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
@agentic-learning learn [pattern name]
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Examples:
|
|
111
|
+
- `@agentic-learning learn OKLCH color spaces`
|
|
112
|
+
- `@agentic-learning learn container queries vs media queries`
|
|
113
|
+
- `@agentic-learning learn exponential easing curves`
|
|
114
|
+
- `@agentic-learning learn fluid typography with clamp()`
|
|
115
|
+
|
|
116
|
+
The `learn` action uses active retrieval — you explain what you know first, then gaps are filled. This is how design patterns become intuition, not just copy-paste.
|
|
117
|
+
|
|
118
|
+
### Quiz yourself on design principles
|
|
119
|
+
|
|
120
|
+
After reading the design skill reference files:
|
|
121
|
+
```
|
|
122
|
+
@agentic-learning quiz typography
|
|
123
|
+
@agentic-learning quiz color-and-contrast
|
|
124
|
+
@agentic-learning quiz motion-design
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## The Full Design-Learning Loop
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
brainstorm → build → /critique → /polish → reflect → space
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
1. `@agentic-learning brainstorm` — clarify the problem and approach
|
|
136
|
+
2. Build with steering commands as checkpoints
|
|
137
|
+
3. `/critique` — honest quality check
|
|
138
|
+
4. `/polish` — elevate and refine
|
|
139
|
+
5. `@agentic-learning reflect` — consolidate what you learned
|
|
140
|
+
6. `@agentic-learning space` — schedule patterns for review
|
|
141
|
+
|
|
142
|
+
Each time through this loop, the design decisions get better — not because the AI gets better, but because *you* do.
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Model Profiles
|
|
2
|
+
|
|
3
|
+
Model profiles control which AI model each learnship agent uses. This allows balancing quality vs token spend.
|
|
4
|
+
|
|
5
|
+
## Profile Definitions
|
|
6
|
+
|
|
7
|
+
| Agent | `quality` | `balanced` | `budget` |
|
|
8
|
+
|-------|-----------|------------|----------|
|
|
9
|
+
| planner | opus | opus | sonnet |
|
|
10
|
+
| roadmapper | opus | sonnet | sonnet |
|
|
11
|
+
| executor | opus | sonnet | sonnet |
|
|
12
|
+
| phase-researcher | opus | sonnet | haiku |
|
|
13
|
+
| project-researcher | opus | sonnet | haiku |
|
|
14
|
+
| research-synthesizer | sonnet | sonnet | haiku |
|
|
15
|
+
| debugger | opus | sonnet | sonnet |
|
|
16
|
+
| codebase-mapper | sonnet | haiku | haiku |
|
|
17
|
+
| verifier | sonnet | sonnet | haiku |
|
|
18
|
+
| plan-checker | sonnet | sonnet | haiku |
|
|
19
|
+
| integration-checker | sonnet | sonnet | haiku |
|
|
20
|
+
| nyquist-auditor | sonnet | sonnet | haiku |
|
|
21
|
+
|
|
22
|
+
## Profile Philosophy
|
|
23
|
+
|
|
24
|
+
**quality** - Maximum reasoning power
|
|
25
|
+
- Opus for all decision-making agents
|
|
26
|
+
- Sonnet for read-only verification
|
|
27
|
+
- Use when: quota available, critical architecture work
|
|
28
|
+
|
|
29
|
+
**balanced** (default) - Smart allocation
|
|
30
|
+
- Opus only for planning (where architecture decisions happen)
|
|
31
|
+
- Sonnet for execution and research (follows explicit instructions)
|
|
32
|
+
- Sonnet for verification (needs reasoning, not just pattern matching)
|
|
33
|
+
- Use when: normal development, good balance of quality and cost
|
|
34
|
+
|
|
35
|
+
**budget** - Minimal Opus usage
|
|
36
|
+
- Sonnet for anything that writes code
|
|
37
|
+
- Haiku for research and verification
|
|
38
|
+
- Use when: conserving quota, high-volume work, less critical phases
|
|
39
|
+
|
|
40
|
+
## Resolution Logic
|
|
41
|
+
|
|
42
|
+
Resolution order:
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
1. Read .planning/config.json
|
|
46
|
+
2. Check model_overrides for agent-specific override
|
|
47
|
+
3. If no override, look up agent in profile table
|
|
48
|
+
4. Apply the resolved profile when adopting the agent persona
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Per-Agent Overrides
|
|
52
|
+
|
|
53
|
+
Override specific agents without changing the entire profile:
|
|
54
|
+
|
|
55
|
+
```json
|
|
56
|
+
{
|
|
57
|
+
"model_profile": "balanced",
|
|
58
|
+
"model_overrides": {
|
|
59
|
+
"executor": "opus",
|
|
60
|
+
"planner": "haiku"
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Overrides take precedence over the profile. Valid values: `opus`, `sonnet`, `haiku`.
|
|
66
|
+
|
|
67
|
+
## Switching Profiles
|
|
68
|
+
|
|
69
|
+
Runtime: `/set-profile <profile>`
|
|
70
|
+
|
|
71
|
+
Per-project default: Set in `.planning/config.json`:
|
|
72
|
+
```json
|
|
73
|
+
{
|
|
74
|
+
"model_profile": "balanced"
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Design Rationale
|
|
79
|
+
|
|
80
|
+
**Why Opus for the planner?**
|
|
81
|
+
Planning involves architecture decisions, goal decomposition, and task design. This is where model quality has the highest impact.
|
|
82
|
+
|
|
83
|
+
**Why Sonnet for the executor?**
|
|
84
|
+
Executors follow explicit PLAN.md instructions. The plan already contains the reasoning; execution is implementation.
|
|
85
|
+
|
|
86
|
+
**Why Sonnet (not Haiku) for verifiers in balanced?**
|
|
87
|
+
Verification requires goal-backward reasoning — checking if code *delivers* what the phase promised, not just pattern matching. Sonnet handles this well; Haiku may miss subtle gaps.
|
|
88
|
+
|
|
89
|
+
**Why Haiku for the codebase-mapper?**
|
|
90
|
+
Read-only exploration and pattern extraction. No reasoning required, just structured output from file contents.
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
<planning_config>
|
|
2
|
+
|
|
3
|
+
Configuration options for `.planning/` directory behavior.
|
|
4
|
+
|
|
5
|
+
<config_schema>
|
|
6
|
+
```json
|
|
7
|
+
"planning": {
|
|
8
|
+
"commit_docs": true,
|
|
9
|
+
"search_gitignored": false
|
|
10
|
+
},
|
|
11
|
+
"git": {
|
|
12
|
+
"branching_strategy": "none",
|
|
13
|
+
"phase_branch_template": "phase-{phase}-{slug}",
|
|
14
|
+
"milestone_branch_template": "{milestone}-{slug}"
|
|
15
|
+
}
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
| Option | Default | Description |
|
|
19
|
+
|--------|---------|-------------|
|
|
20
|
+
| `commit_docs` | `true` | Whether to commit planning artifacts to git |
|
|
21
|
+
| `search_gitignored` | `false` | Add `--no-ignore` to broad rg searches |
|
|
22
|
+
| `git.branching_strategy` | `"none"` | Git branching approach: `"none"`, `"phase"`, or `"milestone"` |
|
|
23
|
+
| `git.phase_branch_template` | `"phase-{phase}-{slug}"` | Branch template for phase strategy |
|
|
24
|
+
| `git.milestone_branch_template` | `"{milestone}-{slug}"` | Branch template for milestone strategy |
|
|
25
|
+
</config_schema>
|
|
26
|
+
|
|
27
|
+
<commit_docs_behavior>
|
|
28
|
+
|
|
29
|
+
**When `commit_docs: true` (default):**
|
|
30
|
+
- Planning files committed normally
|
|
31
|
+
- SUMMARY.md, STATE.md, ROADMAP.md tracked in git
|
|
32
|
+
- Full history of planning decisions preserved
|
|
33
|
+
|
|
34
|
+
**When `commit_docs: false`:**
|
|
35
|
+
- Skip all `git add`/`git commit` for `.planning/` files
|
|
36
|
+
- User must add `.planning/` to `.gitignore`
|
|
37
|
+
- Useful for: OSS contributions, client projects, keeping planning private
|
|
38
|
+
|
|
39
|
+
**Reading `commit_docs` from config:**
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
# Read commit_docs from config.json
|
|
43
|
+
COMMIT_DOCS=$(python3 -c "import json; c=json.load(open('.planning/config.json')); print(c.get('planning',{}).get('commit_docs','true'))" 2>/dev/null || echo 'true')
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
**Auto-detection:** If `.planning/` is gitignored, treat `commit_docs` as `false` regardless of config.json. This prevents git errors.
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# Check if .planning/ is gitignored
|
|
50
|
+
git check-ignore -q .planning && COMMIT_DOCS=false
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
**Committing planning docs (when commit_docs is true):**
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
git add .planning/STATE.md && git commit -m "docs: update state"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
</commit_docs_behavior>
|
|
60
|
+
|
|
61
|
+
<search_behavior>
|
|
62
|
+
|
|
63
|
+
**When `search_gitignored: false` (default):**
|
|
64
|
+
- Standard rg behavior (respects .gitignore)
|
|
65
|
+
- Direct path searches work: `rg "pattern" .planning/` finds files
|
|
66
|
+
- Broad searches skip gitignored: `rg "pattern"` skips `.planning/`
|
|
67
|
+
|
|
68
|
+
**When `search_gitignored: true`:**
|
|
69
|
+
- Add `--no-ignore` to broad rg searches that should include `.planning/`
|
|
70
|
+
- Only needed when searching entire repo and expecting `.planning/` matches
|
|
71
|
+
|
|
72
|
+
**Note:** Most learnship operations use direct file reads or explicit paths, which work regardless of gitignore status.
|
|
73
|
+
|
|
74
|
+
</search_behavior>
|
|
75
|
+
|
|
76
|
+
<setup_uncommitted_mode>
|
|
77
|
+
|
|
78
|
+
To use uncommitted mode:
|
|
79
|
+
|
|
80
|
+
1. **Set config:**
|
|
81
|
+
```json
|
|
82
|
+
"planning": {
|
|
83
|
+
"commit_docs": false,
|
|
84
|
+
"search_gitignored": true
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
2. **Add to .gitignore:**
|
|
89
|
+
```
|
|
90
|
+
.planning/
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
3. **Existing tracked files:** If `.planning/` was previously tracked:
|
|
94
|
+
```bash
|
|
95
|
+
git rm -r --cached .planning/
|
|
96
|
+
git commit -m "chore: stop tracking planning docs"
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
4. **Branch merges:** When using `branching_strategy: phase` or `milestone`, the `complete-milestone` workflow automatically strips `.planning/` files from staging before merge commits when `commit_docs: false`.
|
|
100
|
+
|
|
101
|
+
</setup_uncommitted_mode>
|
|
102
|
+
|
|
103
|
+
<branching_strategy_behavior>
|
|
104
|
+
|
|
105
|
+
**Branching Strategies:**
|
|
106
|
+
|
|
107
|
+
| Strategy | When branch created | Branch scope | Merge point |
|
|
108
|
+
|----------|---------------------|--------------|-------------|
|
|
109
|
+
| `none` | Never | N/A | N/A |
|
|
110
|
+
| `phase` | At `execute-phase` start | Single phase | User merges after phase |
|
|
111
|
+
| `milestone` | At first `execute-phase` of milestone | Entire milestone | At `complete-milestone` |
|
|
112
|
+
|
|
113
|
+
**When `git.branching_strategy: "none"` (default):**
|
|
114
|
+
- All work commits to current branch
|
|
115
|
+
- **Standard learnship behavior**
|
|
116
|
+
|
|
117
|
+
**When `git.branching_strategy: "phase"`:**
|
|
118
|
+
- `execute-phase` creates/switches to a branch before execution
|
|
119
|
+
- Branch name from `phase_branch_template` (e.g., `phase-03-authentication`)
|
|
120
|
+
- All plan commits go to that branch
|
|
121
|
+
- User merges branches manually after phase completion
|
|
122
|
+
- `complete-milestone` offers to merge all phase branches
|
|
123
|
+
|
|
124
|
+
**When `git.branching_strategy: "milestone"`:**
|
|
125
|
+
- First `execute-phase` of milestone creates the milestone branch
|
|
126
|
+
- Branch name from `milestone_branch_template` (e.g., `v1.0-mvp`)
|
|
127
|
+
- All phases in milestone commit to same branch
|
|
128
|
+
- `complete-milestone` offers to merge milestone branch to main
|
|
129
|
+
|
|
130
|
+
**Template variables:**
|
|
131
|
+
|
|
132
|
+
| Variable | Available in | Description |
|
|
133
|
+
|----------|--------------|-------------|
|
|
134
|
+
| `{phase}` | phase_branch_template | Zero-padded phase number (e.g., "03") |
|
|
135
|
+
| `{slug}` | Both | Lowercase, hyphenated name |
|
|
136
|
+
| `{milestone}` | milestone_branch_template | Milestone version (e.g., "v1.0") |
|
|
137
|
+
|
|
138
|
+
**Checking the config:**
|
|
139
|
+
|
|
140
|
+
Read config directly:
|
|
141
|
+
```bash
|
|
142
|
+
python3 -c "import json; c=json.load(open('.planning/config.json')); g=c.get('git',{}); print(g.get('branching_strategy','none'), g.get('phase_branch_template','phase-{phase}-{slug}'), g.get('milestone_branch_template','{milestone}-{slug}'))"
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
**Branch creation:**
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
# For phase strategy
|
|
149
|
+
if [ "$BRANCHING_STRATEGY" = "phase" ]; then
|
|
150
|
+
PHASE_SLUG=$(echo "$PHASE_NAME" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/-/g' | sed 's/--*/-/g' | sed 's/^-//;s/-$//')
|
|
151
|
+
BRANCH_NAME=$(echo "$PHASE_BRANCH_TEMPLATE" | sed "s/{phase}/$PADDED_PHASE/g" | sed "s/{slug}/$PHASE_SLUG/g")
|
|
152
|
+
git checkout -b "$BRANCH_NAME" 2>/dev/null || git checkout "$BRANCH_NAME"
|
|
153
|
+
fi
|
|
154
|
+
|
|
155
|
+
# For milestone strategy
|
|
156
|
+
if [ "$BRANCHING_STRATEGY" = "milestone" ]; then
|
|
157
|
+
MILESTONE_SLUG=$(echo "$MILESTONE_NAME" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/-/g' | sed 's/--*/-/g' | sed 's/^-//;s/-$//')
|
|
158
|
+
BRANCH_NAME=$(echo "$MILESTONE_BRANCH_TEMPLATE" | sed "s/{milestone}/$MILESTONE_VERSION/g" | sed "s/{slug}/$MILESTONE_SLUG/g")
|
|
159
|
+
git checkout -b "$BRANCH_NAME" 2>/dev/null || git checkout "$BRANCH_NAME"
|
|
160
|
+
fi
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
**Merge options at complete-milestone:**
|
|
164
|
+
|
|
165
|
+
| Option | Git command | Result |
|
|
166
|
+
|--------|-------------|--------|
|
|
167
|
+
| Squash merge (recommended) | `git merge --squash` | Single clean commit per branch |
|
|
168
|
+
| Merge with history | `git merge --no-ff` | Preserves all individual commits |
|
|
169
|
+
| Delete without merging | `git branch -D` | Discard branch work |
|
|
170
|
+
| Keep branches | (none) | Manual handling later |
|
|
171
|
+
|
|
172
|
+
Squash merge is recommended — keeps main branch history clean while preserving the full development history in the branch (until deleted).
|
|
173
|
+
|
|
174
|
+
**Use cases:**
|
|
175
|
+
|
|
176
|
+
| Strategy | Best for |
|
|
177
|
+
|----------|----------|
|
|
178
|
+
| `none` | Solo development, simple projects |
|
|
179
|
+
| `phase` | Code review per phase, granular rollback, team collaboration |
|
|
180
|
+
| `milestone` | Release branches, staging environments, PR per version |
|
|
181
|
+
|
|
182
|
+
</branching_strategy_behavior>
|
|
183
|
+
|
|
184
|
+
</planning_config>
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
<questioning_guide>
|
|
2
|
+
|
|
3
|
+
Project initialization is dream extraction, not requirements gathering. You're helping the user discover and articulate what they want to build. This isn't a contract negotiation — it's collaborative thinking.
|
|
4
|
+
|
|
5
|
+
<philosophy>
|
|
6
|
+
|
|
7
|
+
**You are a thinking partner, not an interviewer.**
|
|
8
|
+
|
|
9
|
+
The user often has a fuzzy idea. Your job is to help them sharpen it. Ask questions that make them think "oh, I hadn't considered that" or "yes, that's exactly what I mean."
|
|
10
|
+
|
|
11
|
+
Don't interrogate. Collaborate. Don't follow a script. Follow the thread.
|
|
12
|
+
|
|
13
|
+
</philosophy>
|
|
14
|
+
|
|
15
|
+
<the_goal>
|
|
16
|
+
|
|
17
|
+
By the end of questioning, you need enough clarity to write a PROJECT.md that downstream phases can act on:
|
|
18
|
+
|
|
19
|
+
- **Research** needs: what domain to research, what the user already knows, what unknowns exist
|
|
20
|
+
- **Requirements** needs: clear enough vision to scope v1 features
|
|
21
|
+
- **Roadmap** needs: clear enough vision to decompose into phases, what "done" looks like
|
|
22
|
+
- **plan-phase** needs: specific requirements to break into tasks, context for implementation choices
|
|
23
|
+
- **execute-phase** needs: success criteria to verify against, the "why" behind requirements
|
|
24
|
+
|
|
25
|
+
A vague PROJECT.md forces every downstream phase to guess. The cost compounds.
|
|
26
|
+
|
|
27
|
+
</the_goal>
|
|
28
|
+
|
|
29
|
+
<how_to_question>
|
|
30
|
+
|
|
31
|
+
**Start open.** Let them dump their mental model. Don't interrupt with structure.
|
|
32
|
+
|
|
33
|
+
**Follow energy.** Whatever they emphasized, dig into that. What excited them? What problem sparked this?
|
|
34
|
+
|
|
35
|
+
**Challenge vagueness.** Never accept fuzzy answers. "Good" means what? "Users" means who? "Simple" means how?
|
|
36
|
+
|
|
37
|
+
**Make the abstract concrete.** "Walk me through using this." "What does that actually look like?"
|
|
38
|
+
|
|
39
|
+
**Clarify ambiguity.** "When you say Z, do you mean A or B?" "You mentioned X — tell me more."
|
|
40
|
+
|
|
41
|
+
**Know when to stop.** When you understand what they want, why they want it, who it's for, and what done looks like — offer to proceed.
|
|
42
|
+
|
|
43
|
+
</how_to_question>
|
|
44
|
+
|
|
45
|
+
<question_types>
|
|
46
|
+
|
|
47
|
+
Use these as inspiration, not a checklist. Pick what's relevant to the thread.
|
|
48
|
+
|
|
49
|
+
**Motivation — why this exists:**
|
|
50
|
+
- "What prompted this?"
|
|
51
|
+
- "What are you doing today that this replaces?"
|
|
52
|
+
- "What would you do if this existed?"
|
|
53
|
+
|
|
54
|
+
**Concreteness — what it actually is:**
|
|
55
|
+
- "Walk me through using this"
|
|
56
|
+
- "You said X — what does that actually look like?"
|
|
57
|
+
- "Give me an example"
|
|
58
|
+
|
|
59
|
+
**Clarification — what they mean:**
|
|
60
|
+
- "When you say Z, do you mean A or B?"
|
|
61
|
+
- "You mentioned X — tell me more about that"
|
|
62
|
+
|
|
63
|
+
**Success — how you'll know it's working:**
|
|
64
|
+
- "How will you know this is working?"
|
|
65
|
+
- "What does done look like?"
|
|
66
|
+
|
|
67
|
+
</question_types>
|
|
68
|
+
|
|
69
|
+
<using_askuserquestion>
|
|
70
|
+
|
|
71
|
+
Use AskUserQuestion to help users think by presenting concrete options to react to.
|
|
72
|
+
|
|
73
|
+
**Good options:**
|
|
74
|
+
- Interpretations of what they might mean
|
|
75
|
+
- Specific examples to confirm or deny
|
|
76
|
+
- Concrete choices that reveal priorities
|
|
77
|
+
|
|
78
|
+
**Bad options:**
|
|
79
|
+
- Generic categories ("Technical", "Business", "Other")
|
|
80
|
+
- Leading options that presume an answer
|
|
81
|
+
- Too many options (2-4 is ideal)
|
|
82
|
+
- Headers longer than 12 characters (hard limit — validation will reject them)
|
|
83
|
+
|
|
84
|
+
**Example — vague answer:**
|
|
85
|
+
User says "it should be fast"
|
|
86
|
+
|
|
87
|
+
- header: "Fast"
|
|
88
|
+
- question: "Fast how?"
|
|
89
|
+
- options: ["Sub-second response", "Handles large datasets", "Quick to build", "Let me explain"]
|
|
90
|
+
|
|
91
|
+
**Example — following a thread:**
|
|
92
|
+
User mentions "frustrated with current tools"
|
|
93
|
+
|
|
94
|
+
- header: "Frustration"
|
|
95
|
+
- question: "What specifically frustrates you?"
|
|
96
|
+
- options: ["Too many clicks", "Missing features", "Unreliable", "Let me explain"]
|
|
97
|
+
|
|
98
|
+
**Tip for users — modifying an option:**
|
|
99
|
+
Users who want a slightly modified version of an option can select "Other" and reference the option by number: `#1 but for finger joints only` or `#2 with pagination disabled`. This avoids retyping the full option text.
|
|
100
|
+
|
|
101
|
+
</using_askuserquestion>
|
|
102
|
+
|
|
103
|
+
<freeform_rule>
|
|
104
|
+
|
|
105
|
+
**When the user wants to explain freely, STOP using AskUserQuestion.**
|
|
106
|
+
|
|
107
|
+
If a user selects "Other" and their response signals they want to describe something in their own words (e.g., "let me describe it", "I'll explain", "something else", or any open-ended reply that isn't choosing/modifying an existing option), you MUST:
|
|
108
|
+
|
|
109
|
+
1. **Ask your follow-up as plain text** — NOT via AskUserQuestion
|
|
110
|
+
2. **Wait for them to type at the normal prompt**
|
|
111
|
+
3. **Resume AskUserQuestion** only after processing their freeform response
|
|
112
|
+
|
|
113
|
+
The same applies if YOU include a freeform-indicating option (like "Let me explain" or "Describe in detail") and the user selects it.
|
|
114
|
+
|
|
115
|
+
**Wrong:** User says "let me describe it" → AskUserQuestion("What feature?", ["Feature A", "Feature B", "Describe in detail"])
|
|
116
|
+
**Right:** User says "let me describe it" → "Go ahead — what are you thinking?"
|
|
117
|
+
|
|
118
|
+
</freeform_rule>
|
|
119
|
+
|
|
120
|
+
<context_checklist>
|
|
121
|
+
|
|
122
|
+
Use this as a **background checklist**, not a conversation structure. Check these mentally as you go. If gaps remain, weave questions naturally.
|
|
123
|
+
|
|
124
|
+
- [ ] What they're building (concrete enough to explain to a stranger)
|
|
125
|
+
- [ ] Why it needs to exist (the problem or desire driving it)
|
|
126
|
+
- [ ] Who it's for (even if just themselves)
|
|
127
|
+
- [ ] What "done" looks like (observable outcomes)
|
|
128
|
+
|
|
129
|
+
Four things. If they volunteer more, capture it.
|
|
130
|
+
|
|
131
|
+
</context_checklist>
|
|
132
|
+
|
|
133
|
+
<decision_gate>
|
|
134
|
+
|
|
135
|
+
When you could write a clear PROJECT.md, offer to proceed:
|
|
136
|
+
|
|
137
|
+
- header: "Ready?"
|
|
138
|
+
- question: "I think I understand what you're after. Ready to create PROJECT.md?"
|
|
139
|
+
- options:
|
|
140
|
+
- "Create PROJECT.md" — Let's move forward
|
|
141
|
+
- "Keep exploring" — I want to share more / ask me more
|
|
142
|
+
|
|
143
|
+
If "Keep exploring" — ask what they want to add or identify gaps and probe naturally.
|
|
144
|
+
|
|
145
|
+
Loop until "Create PROJECT.md" selected.
|
|
146
|
+
|
|
147
|
+
</decision_gate>
|
|
148
|
+
|
|
149
|
+
<anti_patterns>
|
|
150
|
+
|
|
151
|
+
- **Checklist walking** — Going through domains regardless of what they said
|
|
152
|
+
- **Canned questions** — "What's your core value?" "What's out of scope?" regardless of context
|
|
153
|
+
- **Corporate speak** — "What are your success criteria?" "Who are your stakeholders?"
|
|
154
|
+
- **Interrogation** — Firing questions without building on answers
|
|
155
|
+
- **Rushing** — Minimizing questions to get to "the work"
|
|
156
|
+
- **Shallow acceptance** — Taking vague answers without probing
|
|
157
|
+
- **Premature constraints** — Asking about tech stack before understanding the idea
|
|
158
|
+
- **User skills** — NEVER ask about user's technical experience. Claude builds.
|
|
159
|
+
|
|
160
|
+
</anti_patterns>
|
|
161
|
+
|
|
162
|
+
</questioning_guide>
|