ragarciaruben 1.20.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/copilot-context/README.md +313 -0
- package/.github/copilot-context/agents/executor.agent.md +59 -0
- package/.github/copilot-context/agents/planner.agent.md +58 -0
- package/.github/copilot-context/agents/verifier.agent.md +68 -0
- package/.github/copilot-context/hooks/hooks.json +11 -0
- package/.github/copilot-context/hooks/inject-context.js +107 -0
- package/.github/copilot-context/instructions/architecture.instructions.md +33 -0
- package/.github/copilot-context/instructions/concerns.instructions.md +30 -0
- package/.github/copilot-context/instructions/conventions.instructions.md +25 -0
- package/.github/copilot-context/instructions/integrations.instructions.md +30 -0
- package/.github/copilot-context/instructions/stack.instructions.md +30 -0
- package/.github/copilot-context/instructions/structure.instructions.md +32 -0
- package/.github/copilot-context/instructions/testing.instructions.md +25 -0
- package/.github/copilot-context/prompts/execute-phase.prompt.md +148 -0
- package/.github/copilot-context/prompts/map-codebase.prompt.md +115 -0
- package/.github/copilot-context/prompts/new-project.prompt.md +85 -0
- package/.github/copilot-context/prompts/pause-work.prompt.md +104 -0
- package/.github/copilot-context/prompts/plan-phase.prompt.md +137 -0
- package/.github/copilot-context/prompts/progress.prompt.md +69 -0
- package/.github/copilot-context/prompts/resume-work.prompt.md +74 -0
- package/.github/copilot-context/prompts/sync-instructions.prompt.md +86 -0
- package/.github/copilot-context/prompts/verify-work.prompt.md +126 -0
- package/.github/copilot-context/skills/map-codebase/SKILL.md +49 -0
- package/.github/copilot-context/skills/project-history/SKILL.md +46 -0
- package/.github/copilot-instructions.md +68 -0
- package/.planning/PROJECT.md +61 -0
- package/.planning/REQUIREMENTS.md +70 -0
- package/.planning/ROADMAP.md +75 -0
- package/.planning/STATE.md +75 -0
- package/.planning/codebase/ARCHITECTURE.md +76 -0
- package/.planning/codebase/CONCERNS.md +102 -0
- package/.planning/codebase/CONVENTIONS.md +119 -0
- package/.planning/codebase/INTEGRATIONS.md +114 -0
- package/.planning/codebase/STACK.md +78 -0
- package/.planning/codebase/STRUCTURE.md +75 -0
- package/.planning/codebase/TESTING.md +157 -0
- package/.planning/continue-here.md +44 -0
- package/.vscode/settings.json +16 -0
- package/LICENSE +21 -0
- package/README.md +704 -0
- package/agents/gsd-codebase-mapper.md +764 -0
- package/agents/gsd-debugger.md +1246 -0
- package/agents/gsd-executor.md +469 -0
- package/agents/gsd-integration-checker.md +443 -0
- package/agents/gsd-phase-researcher.md +546 -0
- package/agents/gsd-plan-checker.md +690 -0
- package/agents/gsd-planner.md +1275 -0
- package/agents/gsd-project-researcher.md +621 -0
- package/agents/gsd-research-synthesizer.md +239 -0
- package/agents/gsd-roadmapper.md +642 -0
- package/agents/gsd-verifier.md +573 -0
- package/bin/install.js +2091 -0
- package/bin/setup-copilot-context.js +180 -0
- package/commands/gsd/add-phase.md +43 -0
- package/commands/gsd/add-tests.md +41 -0
- package/commands/gsd/add-todo.md +47 -0
- package/commands/gsd/audit-milestone.md +36 -0
- package/commands/gsd/check-todos.md +45 -0
- package/commands/gsd/cleanup.md +18 -0
- package/commands/gsd/complete-milestone.md +136 -0
- package/commands/gsd/debug.md +167 -0
- package/commands/gsd/discuss-phase.md +83 -0
- package/commands/gsd/execute-phase.md +41 -0
- package/commands/gsd/health.md +22 -0
- package/commands/gsd/help.md +22 -0
- package/commands/gsd/insert-phase.md +32 -0
- package/commands/gsd/join-discord.md +18 -0
- package/commands/gsd/list-phase-assumptions.md +46 -0
- package/commands/gsd/map-codebase.md +71 -0
- package/commands/gsd/new-milestone.md +44 -0
- package/commands/gsd/new-project.md +42 -0
- package/commands/gsd/new-project.md.bak +1041 -0
- package/commands/gsd/pause-work.md +38 -0
- package/commands/gsd/plan-milestone-gaps.md +34 -0
- package/commands/gsd/plan-phase.md +45 -0
- package/commands/gsd/progress.md +24 -0
- package/commands/gsd/quick.md +41 -0
- package/commands/gsd/reapply-patches.md +110 -0
- package/commands/gsd/remove-phase.md +31 -0
- package/commands/gsd/research-phase.md +189 -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 +38 -0
- package/get-shit-done/bin/gsd-tools.cjs +585 -0
- package/get-shit-done/bin/lib/commands.cjs +553 -0
- package/get-shit-done/bin/lib/config.cjs +162 -0
- package/get-shit-done/bin/lib/core.cjs +411 -0
- package/get-shit-done/bin/lib/frontmatter.cjs +299 -0
- package/get-shit-done/bin/lib/init.cjs +710 -0
- package/get-shit-done/bin/lib/milestone.cjs +215 -0
- package/get-shit-done/bin/lib/phase.cjs +870 -0
- package/get-shit-done/bin/lib/roadmap.cjs +298 -0
- package/get-shit-done/bin/lib/state.cjs +521 -0
- package/get-shit-done/bin/lib/template.cjs +222 -0
- package/get-shit-done/bin/lib/verify.cjs +772 -0
- package/get-shit-done/references/checkpoints.md +776 -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 +164 -0
- package/get-shit-done/templates/UAT.md +247 -0
- package/get-shit-done/templates/VALIDATION.md +76 -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 +37 -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 +569 -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/retrospective.md +54 -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 +248 -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-tests.md +350 -0
- package/get-shit-done/workflows/add-todo.md +157 -0
- package/get-shit-done/workflows/audit-milestone.md +297 -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 +763 -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 +542 -0
- package/get-shit-done/workflows/execute-phase.md +449 -0
- package/get-shit-done/workflows/execute-plan.md +448 -0
- package/get-shit-done/workflows/health.md +156 -0
- package/get-shit-done/workflows/help.md +489 -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 +315 -0
- package/get-shit-done/workflows/new-milestone.md +382 -0
- package/get-shit-done/workflows/new-project.md +1116 -0
- package/get-shit-done/workflows/pause-work.md +122 -0
- package/get-shit-done/workflows/plan-milestone-gaps.md +274 -0
- package/get-shit-done/workflows/plan-phase.md +569 -0
- package/get-shit-done/workflows/progress.md +381 -0
- package/get-shit-done/workflows/quick.md +453 -0
- package/get-shit-done/workflows/remove-phase.md +154 -0
- package/get-shit-done/workflows/research-phase.md +73 -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 +213 -0
- package/get-shit-done/workflows/transition.md +544 -0
- package/get-shit-done/workflows/update.md +219 -0
- package/get-shit-done/workflows/verify-phase.md +242 -0
- package/get-shit-done/workflows/verify-work.md +569 -0
- package/hooks/dist/gsd-check-update.js +62 -0
- package/hooks/dist/gsd-context-monitor.js +122 -0
- package/hooks/dist/gsd-statusline.js +108 -0
- package/package.json +54 -0
- package/scripts/build-hooks.js +43 -0
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: plan-phase
|
|
3
|
+
description: Plan implementation for a roadmap phase — produces a detailed, executable step-by-step plan
|
|
4
|
+
mode: agent
|
|
5
|
+
tools:
|
|
6
|
+
- editFiles
|
|
7
|
+
- search
|
|
8
|
+
- runTerminalCommand
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Plan Phase
|
|
12
|
+
|
|
13
|
+
**Usage:** `/plan-phase [phase-number]` — e.g., `/plan-phase 1` or `/plan-phase 2`
|
|
14
|
+
|
|
15
|
+
Plan the implementation for the specified roadmap phase. Produces a concrete, step-by-step plan ready for execution.
|
|
16
|
+
|
|
17
|
+
## Step 1: Load Phase Context
|
|
18
|
+
|
|
19
|
+
Read these files:
|
|
20
|
+
- `.planning/ROADMAP.md` — find the phase goal, dependencies, requirements, and success criteria
|
|
21
|
+
- `.planning/REQUIREMENTS.md` — find the full requirements for this phase
|
|
22
|
+
- `.planning/PROJECT.md` — constraints and key decisions
|
|
23
|
+
- `.planning/STATE.md` — current position, any relevant accumulated context
|
|
24
|
+
|
|
25
|
+
Load relevant codebase docs based on the phase type:
|
|
26
|
+
| Phase involves... | Load these docs |
|
|
27
|
+
|-------------------|----------------|
|
|
28
|
+
| UI, frontend, components | `.planning/codebase/CONVENTIONS.md` + `.planning/codebase/STRUCTURE.md` |
|
|
29
|
+
| API, backend, endpoints | `.planning/codebase/ARCHITECTURE.md` + `.planning/codebase/CONVENTIONS.md` |
|
|
30
|
+
| Database, schema, models | `.planning/codebase/ARCHITECTURE.md` + `.planning/codebase/STACK.md` |
|
|
31
|
+
| Testing | `.planning/codebase/TESTING.md` + `.planning/codebase/CONVENTIONS.md` |
|
|
32
|
+
| Integration, external API | `.planning/codebase/INTEGRATIONS.md` + `.planning/codebase/STACK.md` |
|
|
33
|
+
| Refactor, cleanup | `.planning/codebase/CONCERNS.md` + `.planning/codebase/ARCHITECTURE.md` |
|
|
34
|
+
| Setup, config | `.planning/codebase/STACK.md` + `.planning/codebase/STRUCTURE.md` |
|
|
35
|
+
|
|
36
|
+
## Step 2: Explore Relevant Code
|
|
37
|
+
|
|
38
|
+
Before planning, explore the codebase to understand the current state:
|
|
39
|
+
```bash
|
|
40
|
+
# Find existing code related to the phase domain
|
|
41
|
+
grep -rn "[relevant terms]" src/ --include="*.ts" 2>/dev/null | head -30
|
|
42
|
+
|
|
43
|
+
# Check existing file structure for the area
|
|
44
|
+
ls -la src/[relevant-directory]/ 2>/dev/null
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Don't guess — look at actual code before designing the plan.
|
|
48
|
+
|
|
49
|
+
## Step 3: Identify Implementation Decisions
|
|
50
|
+
|
|
51
|
+
Before writing the plan, think through and document key decisions:
|
|
52
|
+
|
|
53
|
+
- **Approach:** [The implementation strategy you've chosen and why]
|
|
54
|
+
- **New files to create:** [List with exact paths]
|
|
55
|
+
- **Existing files to modify:** [List with exact paths and what changes]
|
|
56
|
+
- **Dependencies:** [Any new packages needed]
|
|
57
|
+
- **Deferred:** [Things that could fit here but are out of scope]
|
|
58
|
+
|
|
59
|
+
If you're uncertain about architectural choices, ask the user before proceeding.
|
|
60
|
+
|
|
61
|
+
## Step 4: Write the Plan
|
|
62
|
+
|
|
63
|
+
Write the plan file to `.planning/phases/[NN]-[phase-name]/[NN]-01-[plan-name].md`:
|
|
64
|
+
|
|
65
|
+
```markdown
|
|
66
|
+
---
|
|
67
|
+
phase: [phase-number]
|
|
68
|
+
plan: [NN]-01
|
|
69
|
+
name: [descriptive plan name]
|
|
70
|
+
goal: [what this plan delivers]
|
|
71
|
+
status: ready
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
# Plan [NN]-01: [Plan Name]
|
|
75
|
+
|
|
76
|
+
## Goal
|
|
77
|
+
[What this plan delivers — user-observable outcome]
|
|
78
|
+
|
|
79
|
+
## Context & Decisions
|
|
80
|
+
[Key implementation decisions made for this plan and their rationale]
|
|
81
|
+
|
|
82
|
+
## Steps
|
|
83
|
+
|
|
84
|
+
### 1. [Step name]
|
|
85
|
+
[Precise description — file paths, function signatures, what to implement]
|
|
86
|
+
|
|
87
|
+
**Files:**
|
|
88
|
+
- Create: `src/[path]/[file].ts`
|
|
89
|
+
- Modify: `src/[path]/[existing].ts`
|
|
90
|
+
|
|
91
|
+
**Implementation:**
|
|
92
|
+
[Specifics — data structures, algorithms, API contracts, patterns to follow]
|
|
93
|
+
|
|
94
|
+
### 2. [Step name]
|
|
95
|
+
[etc.]
|
|
96
|
+
|
|
97
|
+
### N. Tests
|
|
98
|
+
[Specific test cases to write — description of each scenario]
|
|
99
|
+
|
|
100
|
+
## Success Criteria
|
|
101
|
+
- [ ] [Observable behavior that proves this plan is complete]
|
|
102
|
+
- [ ] [Observable behavior]
|
|
103
|
+
- [ ] All tests pass (`npm test`)
|
|
104
|
+
- [ ] No TypeScript errors (`tsc --noEmit`)
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
If the phase requires multiple plans, create `[NN]-02-[name].md`, `[NN]-03-[name].md`, etc.
|
|
108
|
+
|
|
109
|
+
## Step 5: Update ROADMAP.md
|
|
110
|
+
|
|
111
|
+
Update the plan list in `.planning/ROADMAP.md` for this phase:
|
|
112
|
+
```
|
|
113
|
+
Plans:
|
|
114
|
+
- [ ] [NN]-01: [Brief description]
|
|
115
|
+
- [ ] [NN]-02: [Brief description]
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Step 6: Update STATE.md
|
|
119
|
+
|
|
120
|
+
Update `.planning/STATE.md`:
|
|
121
|
+
- Status: `Ready to execute`
|
|
122
|
+
- Current focus: this phase
|
|
123
|
+
- Note the key decisions made during planning under Accumulated Context
|
|
124
|
+
|
|
125
|
+
## Completion
|
|
126
|
+
|
|
127
|
+
Print a summary:
|
|
128
|
+
```
|
|
129
|
+
✅ Phase [N] planned: [Phase Name]
|
|
130
|
+
[N] plans created in .planning/phases/[NN]-[name]/
|
|
131
|
+
|
|
132
|
+
Plans:
|
|
133
|
+
[NN]-01: [Name] — [brief description]
|
|
134
|
+
[NN]-02: [Name] — [brief description]
|
|
135
|
+
|
|
136
|
+
Ready to execute. Run /execute-phase [N] to start implementation.
|
|
137
|
+
```
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: progress
|
|
3
|
+
description: Show current project progress — phase status, completion percentage, and what's next
|
|
4
|
+
mode: ask
|
|
5
|
+
tools:
|
|
6
|
+
- search
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Show Progress
|
|
10
|
+
|
|
11
|
+
Read the following files and produce a progress report:
|
|
12
|
+
|
|
13
|
+
1. `.planning/STATE.md` — current position, metrics, last activity
|
|
14
|
+
2. `.planning/ROADMAP.md` — all phases, their plans, completion status
|
|
15
|
+
3. `.planning/REQUIREMENTS.md` — requirement completion status
|
|
16
|
+
|
|
17
|
+
Generate a progress report in this format:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
21
|
+
[Project Name] — Progress Report
|
|
22
|
+
[date]
|
|
23
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
24
|
+
|
|
25
|
+
Current Position
|
|
26
|
+
Phase [X] of [Y]: [Phase Name]
|
|
27
|
+
Status: [In progress / Ready to execute / Planning]
|
|
28
|
+
Last activity: [date] — [what happened]
|
|
29
|
+
|
|
30
|
+
Progress: [███████░░░░░░░░] [N]%
|
|
31
|
+
|
|
32
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
33
|
+
|
|
34
|
+
Phase Overview
|
|
35
|
+
|
|
36
|
+
✅ Phase 1: [Name] — complete
|
|
37
|
+
✅ Phase 2: [Name] — complete
|
|
38
|
+
🔄 Phase 3: [Name] — in progress ([N]/[M] plans done)
|
|
39
|
+
└─ ✅ 03-01: [Plan name]
|
|
40
|
+
└─ 🔄 03-02: [Plan name] ← current
|
|
41
|
+
└─ ⬜ 03-03: [Plan name]
|
|
42
|
+
⬜ Phase 4: [Name] — not started
|
|
43
|
+
⬜ Phase 5: [Name] — not started
|
|
44
|
+
|
|
45
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
46
|
+
|
|
47
|
+
Requirements Coverage
|
|
48
|
+
|
|
49
|
+
v1: [N checked] / [M total] ([X]%)
|
|
50
|
+
✅ [AUTH-01, AUTH-02, AUTH-03]
|
|
51
|
+
❌ [CORE-02, CORE-03] — not yet started (Phase 4)
|
|
52
|
+
|
|
53
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
54
|
+
|
|
55
|
+
Metrics
|
|
56
|
+
Plans completed: [N]
|
|
57
|
+
Total time: [X] hours (est.)
|
|
58
|
+
|
|
59
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
60
|
+
|
|
61
|
+
Next Steps
|
|
62
|
+
|
|
63
|
+
[Immediate next action — what to run or do]
|
|
64
|
+
|
|
65
|
+
Commands:
|
|
66
|
+
/plan-phase [N] — plan the current phase
|
|
67
|
+
/execute-phase [N] — execute planned phase
|
|
68
|
+
/verify-work [N] — verify completed phase
|
|
69
|
+
```
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: resume-work
|
|
3
|
+
description: Resume work from a saved session state — reads .planning/continue-here.md and .planning/STATE.md to orient the next session
|
|
4
|
+
mode: ask
|
|
5
|
+
tools:
|
|
6
|
+
- search
|
|
7
|
+
- runTerminalCommand
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Resume Work
|
|
11
|
+
|
|
12
|
+
Load the saved session state and orient this session to continue exactly where the last one left off.
|
|
13
|
+
|
|
14
|
+
## Step 1: Load Context
|
|
15
|
+
|
|
16
|
+
Read these files in order:
|
|
17
|
+
1. `.planning/continue-here.md` — exact resume point (if it exists)
|
|
18
|
+
2. `.planning/STATE.md` — current project position and metrics
|
|
19
|
+
3. `.planning/ROADMAP.md` — phase and plan context
|
|
20
|
+
|
|
21
|
+
If `.planning/continue-here.md` does not exist, fall back to STATE.md and ROADMAP.md only.
|
|
22
|
+
|
|
23
|
+
## Step 2: Verify Environment
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Confirm current git state
|
|
27
|
+
git status
|
|
28
|
+
git log --oneline -3
|
|
29
|
+
git branch --show-current
|
|
30
|
+
|
|
31
|
+
# Quick test health check
|
|
32
|
+
npm test 2>&1 | tail -15
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Note any unexpected test failures or uncommitted changes.
|
|
36
|
+
|
|
37
|
+
## Step 3: Present Resume Summary
|
|
38
|
+
|
|
39
|
+
Format the context summary clearly:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
43
|
+
Resuming: [Project Name]
|
|
44
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
45
|
+
|
|
46
|
+
Where We Left Off
|
|
47
|
+
Phase [X] — [Phase Name]
|
|
48
|
+
Plan [A] of [B]
|
|
49
|
+
Last session: [date] — [what happened]
|
|
50
|
+
|
|
51
|
+
Last Completed
|
|
52
|
+
✅ [Last completed item]
|
|
53
|
+
✅ [Item before that]
|
|
54
|
+
|
|
55
|
+
What Remains (current plan)
|
|
56
|
+
◻ [Next task]
|
|
57
|
+
◻ [Task after that]
|
|
58
|
+
|
|
59
|
+
Decisions Locked In
|
|
60
|
+
• [Decision 1]
|
|
61
|
+
• [Decision 2]
|
|
62
|
+
|
|
63
|
+
Watch-Outs
|
|
64
|
+
⚠️ [Any blocker or fragile area to be aware of]
|
|
65
|
+
|
|
66
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
67
|
+
|
|
68
|
+
Exact Next Action
|
|
69
|
+
[Single concrete action to take now]
|
|
70
|
+
|
|
71
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Then ask: "Ready to continue? I'll [describe the immediate next action]."
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: sync-instructions
|
|
3
|
+
description: Regenerate .github/copilot-instructions.md from .planning/ source documents — keeps the always-on context digest up to date
|
|
4
|
+
mode: agent
|
|
5
|
+
tools:
|
|
6
|
+
- editFiles
|
|
7
|
+
- search
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Sync Instructions
|
|
11
|
+
|
|
12
|
+
Regenerate `.github/copilot-instructions.md` from the current state of `.planning/` documents. Run this after significant changes to PROJECT.md, STATE.md, or ROADMAP.md.
|
|
13
|
+
|
|
14
|
+
## Step 1: Read Source Documents
|
|
15
|
+
|
|
16
|
+
Read all of these:
|
|
17
|
+
- `.planning/STATE.md` — current position, last activity, core value reference
|
|
18
|
+
- `.planning/PROJECT.md` — project description, core value, constraints, recent key decisions
|
|
19
|
+
- `.planning/ROADMAP.md` — phase count and current phase status
|
|
20
|
+
|
|
21
|
+
## Step 2: Extract Key Information
|
|
22
|
+
|
|
23
|
+
From the documents, extract:
|
|
24
|
+
|
|
25
|
+
1. **Project description** — the "What This Is" section from PROJECT.md (2-3 sentences)
|
|
26
|
+
2. **Core value** — the single-sentence core value
|
|
27
|
+
3. **Current phase** — phase number, name, status from STATE.md
|
|
28
|
+
4. **Last activity** — date and what happened from STATE.md
|
|
29
|
+
5. **Active constraints** — from PROJECT.md Constraints (pick top 3-4 most impactful)
|
|
30
|
+
6. **Recent key decisions** — from PROJECT.md Key Decisions (last 3-4 entries, most recent first)
|
|
31
|
+
|
|
32
|
+
## Step 3: Rewrite copilot-instructions.md
|
|
33
|
+
|
|
34
|
+
Overwrite `.github/copilot-instructions.md` with a fresh version. Keep it **under 100 lines**. Use this structure:
|
|
35
|
+
|
|
36
|
+
```markdown
|
|
37
|
+
# Project Copilot Instructions
|
|
38
|
+
|
|
39
|
+
<!--
|
|
40
|
+
Auto-generated from .planning/ documents.
|
|
41
|
+
Regenerate with: /sync-instructions
|
|
42
|
+
Last synced: [date]
|
|
43
|
+
-->
|
|
44
|
+
|
|
45
|
+
## What This Project Is
|
|
46
|
+
|
|
47
|
+
[2-3 sentence description from PROJECT.md]
|
|
48
|
+
|
|
49
|
+
**Core value:** [Single sentence from PROJECT.md Core Value]
|
|
50
|
+
|
|
51
|
+
## Current State
|
|
52
|
+
|
|
53
|
+
- **Phase:** [X of Y — Phase Name]
|
|
54
|
+
- **Status:** [Status from STATE.md]
|
|
55
|
+
- **Last activity:** [Date — what happened]
|
|
56
|
+
|
|
57
|
+
## Active Constraints
|
|
58
|
+
|
|
59
|
+
[Top 3-4 constraints — format as "**Type:** What it means for code you write"]
|
|
60
|
+
|
|
61
|
+
## Key Decisions (recent)
|
|
62
|
+
|
|
63
|
+
[Last 3-4 decisions — format as "- [Decision] — [rationale and implication]"]
|
|
64
|
+
|
|
65
|
+
## Where to Find Deep Context
|
|
66
|
+
|
|
67
|
+
[Keep the reference table — update if new documents were added]
|
|
68
|
+
|
|
69
|
+
## Quick Commands (run in Copilot Chat)
|
|
70
|
+
|
|
71
|
+
[Keep the commands table unchanged]
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Step 4: Confirm
|
|
75
|
+
|
|
76
|
+
Print:
|
|
77
|
+
```
|
|
78
|
+
✅ .github/copilot-instructions.md updated
|
|
79
|
+
|
|
80
|
+
Synced from:
|
|
81
|
+
.planning/PROJECT.md → description, constraints, decisions
|
|
82
|
+
.planning/STATE.md → current position, last activity
|
|
83
|
+
.planning/ROADMAP.md → phase count
|
|
84
|
+
|
|
85
|
+
The updated instructions will be auto-loaded on your next Copilot Chat request.
|
|
86
|
+
```
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: verify-work
|
|
3
|
+
description: Verify that completed work meets requirements — checks implementation against .planning/REQUIREMENTS.md and phase success criteria
|
|
4
|
+
mode: agent
|
|
5
|
+
tools:
|
|
6
|
+
- runTerminalCommand
|
|
7
|
+
- search
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Verify Work
|
|
11
|
+
|
|
12
|
+
**Usage:** `/verify-work [phase-number]` — e.g., `/verify-work 1`
|
|
13
|
+
|
|
14
|
+
Verify that the completed phase meets its requirements. Produces a verification report.
|
|
15
|
+
|
|
16
|
+
## Step 1: Load Verification Context
|
|
17
|
+
|
|
18
|
+
Read:
|
|
19
|
+
- `.planning/REQUIREMENTS.md` — requirements covered by this phase (use traceability table)
|
|
20
|
+
- `.planning/ROADMAP.md` — phase success criteria
|
|
21
|
+
- `.planning/codebase/TESTING.md` — test framework and run commands
|
|
22
|
+
- `.planning/STATE.md` — current position
|
|
23
|
+
|
|
24
|
+
## Step 2: Run the Test Suite
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# Full test suite
|
|
28
|
+
npm test 2>&1
|
|
29
|
+
|
|
30
|
+
# Coverage report
|
|
31
|
+
npm run test:coverage 2>&1
|
|
32
|
+
|
|
33
|
+
# TypeScript
|
|
34
|
+
npx tsc --noEmit 2>&1
|
|
35
|
+
|
|
36
|
+
# Linting
|
|
37
|
+
npm run lint 2>&1
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Record: test count, pass/fail, coverage %, any errors.
|
|
41
|
+
|
|
42
|
+
## Step 3: Check Each Requirement
|
|
43
|
+
|
|
44
|
+
For every requirement ID listed for this phase in `REQUIREMENTS.md`:
|
|
45
|
+
|
|
46
|
+
| Requirement | Description | Verification method | Status |
|
|
47
|
+
|-------------|-------------|---------------------|--------|
|
|
48
|
+
| AUTH-01 | User can sign up | Test `POST /auth/register` returns 201 | ✅ / ❌ |
|
|
49
|
+
| AUTH-02 | Password hashed | Check `users` table never stores plaintext | ✅ / ❌ |
|
|
50
|
+
|
|
51
|
+
For each requirement:
|
|
52
|
+
1. Check if there are tests covering it
|
|
53
|
+
2. Look at the implementation code
|
|
54
|
+
3. Mark ✅ if verifiably complete, ❌ if missing or partial
|
|
55
|
+
|
|
56
|
+
## Step 4: Check Phase Success Criteria
|
|
57
|
+
|
|
58
|
+
Read the success criteria from ROADMAP.md for this phase.
|
|
59
|
+
For each criterion — make a call: TRUE or FALSE based on evidence (tests, code inspection, running commands).
|
|
60
|
+
|
|
61
|
+
## Step 5: Write Verification Report
|
|
62
|
+
|
|
63
|
+
Write the report to `.planning/phases/[NN]-[phase-name]/VERIFICATION.md`:
|
|
64
|
+
|
|
65
|
+
```markdown
|
|
66
|
+
# Verification Report: Phase [N] — [Phase Name]
|
|
67
|
+
|
|
68
|
+
**Date:** [date]
|
|
69
|
+
**Verified by:** Copilot agent
|
|
70
|
+
|
|
71
|
+
## Test Results
|
|
72
|
+
- Tests: [N passing] / [M total]
|
|
73
|
+
- Coverage: [X]%
|
|
74
|
+
- TypeScript: [✅ clean / ❌ N errors]
|
|
75
|
+
- Lint: [✅ clean / ❌ N warnings]
|
|
76
|
+
|
|
77
|
+
## Requirements Coverage
|
|
78
|
+
|
|
79
|
+
| Req ID | Description | Status | Evidence |
|
|
80
|
+
|--------|-------------|--------|----------|
|
|
81
|
+
| AUTH-01 | [Brief] | ✅ | [Test name / file:line] |
|
|
82
|
+
| AUTH-02 | [Brief] | ❌ | [What's missing] |
|
|
83
|
+
|
|
84
|
+
## Success Criteria
|
|
85
|
+
|
|
86
|
+
| Criterion | Status | Notes |
|
|
87
|
+
|-----------|--------|-------|
|
|
88
|
+
| [Criterion 1] | ✅ | [Evidence] |
|
|
89
|
+
| [Criterion 2] | ❌ | [What's missing / how to fix] |
|
|
90
|
+
|
|
91
|
+
## Overall: [PASS ✅ / FAIL ❌]
|
|
92
|
+
|
|
93
|
+
[Pass: "All requirements met. Phase [N] is complete."]
|
|
94
|
+
[Fail: "N requirements not met. See gaps below."]
|
|
95
|
+
|
|
96
|
+
## Gaps (if any)
|
|
97
|
+
|
|
98
|
+
### [Requirement ID] — [Description]
|
|
99
|
+
**What's missing:** [Specific gap]
|
|
100
|
+
**Fix needed:** [What to implement]
|
|
101
|
+
**Estimated effort:** [Small / Medium / Large]
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Step 6: Update Documents
|
|
105
|
+
|
|
106
|
+
**If PASS:**
|
|
107
|
+
- Mark requirements as complete in `.planning/REQUIREMENTS.md`: `- [x] **AUTH-01**:`
|
|
108
|
+
- Update `.planning/STATE.md` to show phase verified
|
|
109
|
+
- Move to next phase
|
|
110
|
+
|
|
111
|
+
**If FAIL:**
|
|
112
|
+
- Add gap closure plans to the phase plan directory
|
|
113
|
+
- Update `.planning/STATE.md` with the gaps as blockers
|
|
114
|
+
- Suggest running `/execute-phase [N] --gaps-only`
|
|
115
|
+
|
|
116
|
+
## Completion
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
[PASS ✅ / FAIL ❌] Phase [N] Verification
|
|
120
|
+
|
|
121
|
+
Requirements: [N]/[M] met
|
|
122
|
+
Tests: [N passing]
|
|
123
|
+
Coverage: [X]%
|
|
124
|
+
|
|
125
|
+
[PASS message OR list of gaps to close]
|
|
126
|
+
```
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: map-codebase
|
|
3
|
+
description: Analyzes a codebase and generates 7 structured context documents in .planning/codebase/ — covering architecture, file structure, conventions, testing, tech stack, integrations, and technical concerns
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Codebase Mapper Skill
|
|
7
|
+
|
|
8
|
+
This skill analyzes your codebase and generates 7 structured context documents that Copilot uses on every future request to provide project-aware assistance.
|
|
9
|
+
|
|
10
|
+
## What This Skill Produces
|
|
11
|
+
|
|
12
|
+
| Document | Contents |
|
|
13
|
+
|----------|---------|
|
|
14
|
+
| `ARCHITECTURE.md` | Layers, data flow, key abstractions, entry points |
|
|
15
|
+
| `STRUCTURE.md` | Directory tree, "where to put new code" table, naming conventions |
|
|
16
|
+
| `STACK.md` | Runtime, frameworks, dependencies, infrastructure, env vars |
|
|
17
|
+
| `CONVENTIONS.md` | Coding style, naming, error handling, TypeScript rules |
|
|
18
|
+
| `TESTING.md` | Test framework, patterns, mocking strategy, run commands |
|
|
19
|
+
| `INTEGRATIONS.md` | External services, SDKs, connection patterns, webhook handling |
|
|
20
|
+
| `CONCERNS.md` | Tech debt, known bugs, fragile areas, security notes |
|
|
21
|
+
|
|
22
|
+
## When To Use This Skill
|
|
23
|
+
|
|
24
|
+
- When first setting up context for an existing codebase
|
|
25
|
+
- After a major architectural change
|
|
26
|
+
- When onboarding a new project or team member
|
|
27
|
+
- When context documents feel stale (> 1 month since major changes)
|
|
28
|
+
|
|
29
|
+
## Incremental Refresh
|
|
30
|
+
|
|
31
|
+
To refresh only specific documents, specify the focus area:
|
|
32
|
+
- "Refresh just the conventions" → re-run quality focus
|
|
33
|
+
- "Update the tech stack docs" → re-run tech focus
|
|
34
|
+
- "Check for new concerns" → re-run concerns focus
|
|
35
|
+
|
|
36
|
+
## Related
|
|
37
|
+
|
|
38
|
+
Run corresponding prompt file: `/map-codebase`
|
|
39
|
+
|
|
40
|
+
## Resources
|
|
41
|
+
|
|
42
|
+
- [Analysis prompt template](.github/copilot-context/prompts/map-codebase.prompt.md)
|
|
43
|
+
- [Architecture template](.planning/codebase/ARCHITECTURE.md)
|
|
44
|
+
- [Structure template](.planning/codebase/STRUCTURE.md)
|
|
45
|
+
- [Stack template](.planning/codebase/STACK.md)
|
|
46
|
+
- [Conventions template](.planning/codebase/CONVENTIONS.md)
|
|
47
|
+
- [Testing template](.planning/codebase/TESTING.md)
|
|
48
|
+
- [Integrations template](.planning/codebase/INTEGRATIONS.md)
|
|
49
|
+
- [Concerns template](.planning/codebase/CONCERNS.md)
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: project-history
|
|
3
|
+
description: Accesses historical project context — phase summaries, decisions, retrospectives, and archived milestones. Use when you need to understand past decisions or trace why something was built a certain way.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Project History Skill
|
|
7
|
+
|
|
8
|
+
This skill provides access to historical project context — understanding past decisions, reviewing what was built in previous phases, and tracing the rationale behind architectural choices.
|
|
9
|
+
|
|
10
|
+
## What's Available
|
|
11
|
+
|
|
12
|
+
| Resource | Location | Contents |
|
|
13
|
+
|----------|----------|---------|
|
|
14
|
+
| Phase summaries | `.planning/phases/[NN]-[name]/*.SUMMARY.md` | What was implemented, files changed, decisions made |
|
|
15
|
+
| Verification reports | `.planning/phases/[NN]-[name]/VERIFICATION.md` | Test results, requirement coverage per phase |
|
|
16
|
+
| Key decisions | `.planning/PROJECT.md` → Key Decisions table | All major decisions with rationale |
|
|
17
|
+
| Milestone archives | `.planning/milestones/` (if exists) | Completed milestone documentation |
|
|
18
|
+
| Session logs | `.planning/phases/[NN]-[name]/.continue-here.md` | Saved session states |
|
|
19
|
+
|
|
20
|
+
## When To Use This Skill
|
|
21
|
+
|
|
22
|
+
- "Why was [X] implemented this way?"
|
|
23
|
+
- "What changed in Phase [N]?"
|
|
24
|
+
- "When was [feature] added?"
|
|
25
|
+
- "Did we consider [alternative approach]?"
|
|
26
|
+
- "What decisions locked in this constraint?"
|
|
27
|
+
|
|
28
|
+
## Usage Examples
|
|
29
|
+
|
|
30
|
+
**Trace a decision:**
|
|
31
|
+
"Show me all architectural decisions made in Phase 1-3"
|
|
32
|
+
→ I'll read the SUMMARY.md files and PROJECT.md Key Decisions table
|
|
33
|
+
|
|
34
|
+
**Understand past work:**
|
|
35
|
+
"What did we implement in Phase 2?"
|
|
36
|
+
→ I'll read `.planning/phases/02-name/*.SUMMARY.md`
|
|
37
|
+
|
|
38
|
+
**Check test history:**
|
|
39
|
+
"What was the test coverage when we finished Phase 1?"
|
|
40
|
+
→ I'll read `.planning/phases/01-name/VERIFICATION.md`
|
|
41
|
+
|
|
42
|
+
## Resources
|
|
43
|
+
|
|
44
|
+
- [Project decisions](.planning/PROJECT.md)
|
|
45
|
+
- [Current state](.planning/STATE.md)
|
|
46
|
+
- [Full roadmap](.planning/ROADMAP.md)
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Project Copilot Instructions
|
|
2
|
+
|
|
3
|
+
<!--
|
|
4
|
+
This file is automatically loaded by GitHub Copilot Chat on every request in this workspace.
|
|
5
|
+
Keep it concise (under 100 lines). It is a synthesized digest — full details live in .planning/.
|
|
6
|
+
|
|
7
|
+
To regenerate this file from .planning/ documents, run: /sync-instructions
|
|
8
|
+
-->
|
|
9
|
+
|
|
10
|
+
## What This Project Is
|
|
11
|
+
|
|
12
|
+
<!-- FILL IN: 2-3 sentences. What does this product do and who is it for? -->
|
|
13
|
+
[Project description — update me after running /new-project or /map-codebase]
|
|
14
|
+
|
|
15
|
+
**Core value:** [The one thing that must always work — from .planning/PROJECT.md]
|
|
16
|
+
|
|
17
|
+
## Current State
|
|
18
|
+
|
|
19
|
+
<!-- FILL IN: Keep updated after each session. Run /progress for full status. -->
|
|
20
|
+
- **Phase:** [X of Y — Phase Name]
|
|
21
|
+
- **Status:** [Ready to plan / In progress / Phase complete]
|
|
22
|
+
- **Last activity:** [YYYY-MM-DD — what happened]
|
|
23
|
+
|
|
24
|
+
## Active Constraints
|
|
25
|
+
|
|
26
|
+
<!-- Non-negotiable constraints that apply to ALL work in this codebase. -->
|
|
27
|
+
- **[Type]:** [What it means for code you write]
|
|
28
|
+
- **[Type]:** [What it means for code you write]
|
|
29
|
+
|
|
30
|
+
## Key Decisions (recent)
|
|
31
|
+
|
|
32
|
+
<!-- Decisions that constrain future work. Full history in .planning/PROJECT.md -->
|
|
33
|
+
- [Decision] — [rationale and implication]
|
|
34
|
+
- [Decision] — [rationale and implication]
|
|
35
|
+
|
|
36
|
+
## Where to Find Deep Context
|
|
37
|
+
|
|
38
|
+
All detailed project context lives in `.planning/`:
|
|
39
|
+
|
|
40
|
+
| Document | What's in it |
|
|
41
|
+
|----------|-------------|
|
|
42
|
+
| `.planning/PROJECT.md` | Full requirements, decisions, and constraints |
|
|
43
|
+
| `.planning/REQUIREMENTS.md` | All requirements with IDs and traceability |
|
|
44
|
+
| `.planning/ROADMAP.md` | Phase list with plans and success criteria |
|
|
45
|
+
| `.planning/STATE.md` | Current position and session continuity |
|
|
46
|
+
| `.planning/codebase/ARCHITECTURE.md` | System layers and data flow |
|
|
47
|
+
| `.planning/codebase/STRUCTURE.md` | Where to put new code |
|
|
48
|
+
| `.planning/codebase/CONVENTIONS.md` | Coding style and patterns |
|
|
49
|
+
| `.planning/codebase/TESTING.md` | Test framework and patterns |
|
|
50
|
+
| `.planning/codebase/STACK.md` | Technology stack and dependencies |
|
|
51
|
+
| `.planning/codebase/INTEGRATIONS.md` | External services and APIs |
|
|
52
|
+
| `.planning/codebase/CONCERNS.md` | Tech debt and fragile areas |
|
|
53
|
+
|
|
54
|
+
## Quick Commands (run in Copilot Chat)
|
|
55
|
+
|
|
56
|
+
| Command | Purpose |
|
|
57
|
+
|---------|---------|
|
|
58
|
+
| `/map-codebase` | Analyze codebase and fill in `.planning/codebase/` |
|
|
59
|
+
| `/new-project` | Initialize `.planning/` docs for a new project |
|
|
60
|
+
| `/plan-phase` | Plan implementation for a roadmap phase |
|
|
61
|
+
| `/execute-phase` | Execute a planned phase step-by-step |
|
|
62
|
+
| `/verify-work` | Verify implementation against requirements |
|
|
63
|
+
| `/progress` | Show current progress and roadmap status |
|
|
64
|
+
| `/pause-work` | Save session state to `.planning/continue-here.md` |
|
|
65
|
+
| `/resume-work` | Load session state and continue where you left off |
|
|
66
|
+
| `/sync-instructions` | Regenerate this file from `.planning/` docs |
|
|
67
|
+
|
|
68
|
+
> Full system documentation: [.github/copilot-context/README.md](.github/copilot-context/README.md)
|