ragarciaruben 1.20.19 → 1.20.21
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/agents/product-owner.agent.md +98 -0
- package/.github/agents/verifier.agent.md +3 -0
- package/.github/prompts/break-down-epic.prompt.md +125 -0
- package/.github/prompts/create-tickets.prompt.md +93 -0
- package/.github/prompts/refine-backlog.prompt.md +88 -0
- package/bin/install.js +406 -1969
- package/get-shit-done/templates/AGENTS.md +83 -0
- package/get-shit-done/templates/opencode/agents/executor.md +61 -0
- package/get-shit-done/templates/opencode/agents/planner.md +77 -0
- package/get-shit-done/templates/opencode/agents/product-owner.md +65 -0
- package/{.github/copilot-context/agents/verifier.agent.md → get-shit-done/templates/opencode/agents/verifier.md} +12 -35
- package/get-shit-done/templates/opencode/commands/break-down-epic.md +120 -0
- package/get-shit-done/templates/opencode/commands/create-tickets.md +75 -0
- package/{.github/copilot-context/prompts/execute-phase.prompt.md → get-shit-done/templates/opencode/commands/execute-phase.md} +5 -33
- package/{.github/copilot-context/prompts/map-codebase.prompt.md → get-shit-done/templates/opencode/commands/map-codebase.md} +12 -41
- package/{.github/copilot-context/prompts/new-project.prompt.md → get-shit-done/templates/opencode/commands/new-project.md} +17 -33
- package/{.github/copilot-context/prompts/pause-work.prompt.md → get-shit-done/templates/opencode/commands/pause-work.md} +6 -19
- package/{.github/copilot-context/prompts/plan-phase.prompt.md → get-shit-done/templates/opencode/commands/plan-phase.md} +4 -27
- package/{.github/copilot-context/prompts/progress.prompt.md → get-shit-done/templates/opencode/commands/progress.md} +1 -4
- package/{.github/copilot-context/prompts/redefine-roadmap.prompt.md → get-shit-done/templates/opencode/commands/redefine-roadmap.md} +8 -21
- package/get-shit-done/templates/opencode/commands/refine-backlog.md +77 -0
- package/{.github/copilot-context/prompts/resume-work.prompt.md → get-shit-done/templates/opencode/commands/resume-work.md} +2 -13
- package/get-shit-done/templates/opencode/commands/set-profile.md +65 -0
- package/{.github/copilot-context/prompts/sync-instructions.prompt.md → get-shit-done/templates/opencode/commands/sync-instructions.md} +9 -13
- package/{.github/copilot-context/prompts/sync-jira.prompt.md → get-shit-done/templates/opencode/commands/sync-jira.md} +5 -17
- package/{.github/copilot-context/prompts/verify-work.prompt.md → get-shit-done/templates/opencode/commands/verify-work.md} +5 -33
- package/get-shit-done/templates/opencode.json +15 -0
- package/package.json +7 -17
- package/.github/copilot-context/README.md +0 -556
- package/.github/copilot-context/agents/executor.agent.md +0 -84
- package/.github/copilot-context/agents/planner.agent.md +0 -96
- package/.github/copilot-context/hooks/hooks.json +0 -11
- package/.github/copilot-context/hooks/inject-context.js +0 -107
- package/.github/copilot-context/instructions/architecture.instructions.md +0 -33
- package/.github/copilot-context/instructions/concerns.instructions.md +0 -30
- package/.github/copilot-context/instructions/conventions.instructions.md +0 -25
- package/.github/copilot-context/instructions/integrations.instructions.md +0 -30
- package/.github/copilot-context/instructions/stack.instructions.md +0 -30
- package/.github/copilot-context/instructions/structure.instructions.md +0 -32
- package/.github/copilot-context/instructions/testing.instructions.md +0 -25
- package/.github/copilot-context/skills/map-codebase/SKILL.md +0 -49
- package/.github/copilot-context/skills/project-history/SKILL.md +0 -46
- package/.vscode/settings.json +0 -9
- package/agents/gsd-codebase-mapper.md +0 -764
- package/agents/gsd-debugger.md +0 -1246
- package/agents/gsd-executor.md +0 -469
- package/agents/gsd-integration-checker.md +0 -443
- package/agents/gsd-phase-researcher.md +0 -546
- package/agents/gsd-plan-checker.md +0 -690
- package/agents/gsd-planner.md +0 -1275
- package/agents/gsd-project-researcher.md +0 -621
- package/agents/gsd-research-synthesizer.md +0 -239
- package/agents/gsd-roadmapper.md +0 -642
- package/agents/gsd-verifier.md +0 -573
- package/bin/setup-copilot-context.js +0 -245
- package/commands/gsd/add-phase.md +0 -43
- package/commands/gsd/add-tests.md +0 -41
- package/commands/gsd/add-todo.md +0 -47
- package/commands/gsd/audit-milestone.md +0 -36
- package/commands/gsd/check-todos.md +0 -45
- package/commands/gsd/cleanup.md +0 -18
- package/commands/gsd/complete-milestone.md +0 -136
- package/commands/gsd/debug.md +0 -167
- package/commands/gsd/discuss-phase.md +0 -83
- package/commands/gsd/execute-phase.md +0 -41
- package/commands/gsd/health.md +0 -22
- package/commands/gsd/help.md +0 -22
- package/commands/gsd/insert-phase.md +0 -32
- package/commands/gsd/join-discord.md +0 -18
- package/commands/gsd/list-phase-assumptions.md +0 -46
- package/commands/gsd/map-codebase.md +0 -71
- package/commands/gsd/new-milestone.md +0 -44
- package/commands/gsd/new-project.md +0 -42
- package/commands/gsd/new-project.md.bak +0 -1041
- package/commands/gsd/pause-work.md +0 -38
- package/commands/gsd/plan-milestone-gaps.md +0 -34
- package/commands/gsd/plan-phase.md +0 -45
- package/commands/gsd/progress.md +0 -24
- package/commands/gsd/quick.md +0 -41
- package/commands/gsd/reapply-patches.md +0 -110
- package/commands/gsd/remove-phase.md +0 -31
- package/commands/gsd/research-phase.md +0 -189
- package/commands/gsd/resume-work.md +0 -40
- package/commands/gsd/set-profile.md +0 -34
- package/commands/gsd/settings.md +0 -36
- package/commands/gsd/update.md +0 -37
- package/commands/gsd/verify-work.md +0 -38
- package/hooks/dist/gsd-check-update.js +0 -62
- package/hooks/dist/gsd-context-monitor.js +0 -122
- package/hooks/dist/gsd-statusline.js +0 -108
- package/scripts/build-hooks.js +0 -43
|
@@ -1,556 +0,0 @@
|
|
|
1
|
-
# GSD for GitHub Copilot — User Guide
|
|
2
|
-
|
|
3
|
-
> **Get Shit Done (GSD)** is a context engineering system that makes GitHub Copilot actually understand your project — its architecture, conventions, current state, and what you're working on — across every session.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## TL;DR
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
# Install into any project
|
|
11
|
-
npx ragarciaruben@latest copilot-context
|
|
12
|
-
|
|
13
|
-
# Or pick option 6 from the interactive menu
|
|
14
|
-
npx ragarciaruben@latest
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
Then in VS Code Copilot Chat:
|
|
18
|
-
1. `/map-codebase` — Copilot analyzes your code and writes structured docs
|
|
19
|
-
2. `/new-project` — Set up project goals, requirements, and roadmap
|
|
20
|
-
3. Start working with `/plan-phase`, `/execute-phase`, `/verify-work`
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Table of Contents
|
|
25
|
-
|
|
26
|
-
- [What It Does](#what-it-does)
|
|
27
|
-
- [What It Can and Can't Do](#what-it-can-and-cant-do)
|
|
28
|
-
- [Installation](#installation)
|
|
29
|
-
- [Getting Started (5 minutes)](#getting-started-5-minutes)
|
|
30
|
-
- [Daily Workflow](#daily-workflow)
|
|
31
|
-
- [Slash Commands Reference](#slash-commands-reference)
|
|
32
|
-
- [Agents — Planner, Executor, Verifier](#agents--planner-executor-verifier)
|
|
33
|
-
- [Model Profiles](#model-profiles)
|
|
34
|
-
- [How Instructions Work (you don't touch these)](#how-instructions-work)
|
|
35
|
-
- [The .planning/ Folder — Your Source of Truth](#the-planning-folder--your-source-of-truth)
|
|
36
|
-
- [Customizing for Your Project](#customizing-for-your-project)
|
|
37
|
-
- [Session Continuity — How State Persists](#session-continuity--how-state-persists)
|
|
38
|
-
- [FAQ](#faq)
|
|
39
|
-
- [Compatibility](#compatibility)
|
|
40
|
-
|
|
41
|
-
---
|
|
42
|
-
|
|
43
|
-
## What It Does
|
|
44
|
-
|
|
45
|
-
Every time you open Copilot Chat, the AI starts from zero — it doesn't know your project's architecture, coding style, what phase you're in, or what you were doing yesterday. GSD fixes this.
|
|
46
|
-
|
|
47
|
-
**It gives Copilot:**
|
|
48
|
-
- A structured understanding of your codebase (architecture, conventions, testing patterns, tech stack, integrations, tech debt)
|
|
49
|
-
- Your project requirements, roadmap, and current phase
|
|
50
|
-
- Memory of where you left off across sessions
|
|
51
|
-
- Specialized agents for planning, implementing, and verifying work
|
|
52
|
-
- Slash commands that run structured workflows (not just chat)
|
|
53
|
-
|
|
54
|
-
**Think of it as:** a project manual that Copilot reads automatically so it doesn't ask dumb questions or ignore your conventions.
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
## What It Can and Can't Do
|
|
59
|
-
|
|
60
|
-
### ✅ Can Do
|
|
61
|
-
|
|
62
|
-
| Capability | How |
|
|
63
|
-
|---|---|
|
|
64
|
-
| **Analyze your codebase** and generate context docs | `/map-codebase` — reads your code, produces 7 structured docs |
|
|
65
|
-
| **Plan work** with step-by-step phases | `/plan-phase 3` or `@Planner` agent |
|
|
66
|
-
| **Execute plans** with code edits, terminal commands, commits | `/execute-phase 3` or `@Executor` agent |
|
|
67
|
-
| **Verify work** against requirements automatically | `/verify-work 3` or `@Verifier` agent |
|
|
68
|
-
| **Persist state** across chat sessions | `/pause-work` saves, `/resume-work` restores |
|
|
69
|
-
| **Keep instructions fresh** when your project changes | `/sync-instructions` regenerates the digest |
|
|
70
|
-
| **Switch AI model profiles** (Opus, Sonnet, GPT-4.1) | `/set-profile` — changes model for all agents |
|
|
71
|
-
| **Auto-inject conventions** when editing source/test files | `.instructions.md` files trigger automatically |
|
|
72
|
-
| **Agent handoffs** — Planner → Executor → Verifier | Built-in handoff buttons in agent mode |
|
|
73
|
-
|
|
74
|
-
### ❌ Cannot Do
|
|
75
|
-
|
|
76
|
-
| Limitation | Why | Workaround |
|
|
77
|
-
|---|---|---|
|
|
78
|
-
| **No background agents** — can't spawn subagents in parallel | VS Code Copilot doesn't support subprocess spawning like Claude Code | Use agents sequentially via handoffs |
|
|
79
|
-
| **No automatic hooks** on older VS Code | Session hooks require VS Code 1.109.3+ (Preview) | Run `/resume-work` manually at session start |
|
|
80
|
-
| **Won't auto-update `.planning/` docs** | Copilot won't edit docs unless you tell it to | Run `/map-codebase` periodically, especially after big changes |
|
|
81
|
-
| **Agents don't remember across sessions** | Each Copilot Chat session starts fresh | Use `/pause-work` and `/resume-work` |
|
|
82
|
-
| **Model profiles require manual switch** | No config-file-based auto-detection yet | Run `/set-profile` once per project |
|
|
83
|
-
| **Can't run outside VS Code** | This is a VS Code Copilot system, not a CLI tool | For CLI: use the original GSD with Claude Code/Gemini/Codex |
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
## Installation
|
|
88
|
-
|
|
89
|
-
### Into an existing project
|
|
90
|
-
|
|
91
|
-
```bash
|
|
92
|
-
cd your-project
|
|
93
|
-
npx ragarciaruben@latest copilot-context
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
This creates:
|
|
97
|
-
```
|
|
98
|
-
your-project/
|
|
99
|
-
├── .github/
|
|
100
|
-
│ ├── copilot-instructions.md ← auto-loaded every chat
|
|
101
|
-
│ ├── prompts/ ← slash commands
|
|
102
|
-
│ ├── instructions/ ← conditional context
|
|
103
|
-
│ ├── agents/ ← planner/executor/verifier
|
|
104
|
-
│ └── copilot-context/ ← skills, hooks, reference README
|
|
105
|
-
├── .planning/ ← source-of-truth docs (you fill these in)
|
|
106
|
-
└── .vscode/settings.json ← comments only (no config needed)
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
### Re-install / update
|
|
110
|
-
|
|
111
|
-
```bash
|
|
112
|
-
npx ragarciaruben@latest copilot-context --force
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
`--force` overwrites existing files. Without it, existing files are skipped.
|
|
116
|
-
|
|
117
|
-
---
|
|
118
|
-
|
|
119
|
-
## Getting Started (5 minutes)
|
|
120
|
-
|
|
121
|
-
### Step 1: Install
|
|
122
|
-
|
|
123
|
-
```bash
|
|
124
|
-
cd your-project
|
|
125
|
-
npx ragarciaruben@latest copilot-context
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
### Step 2: Map your codebase
|
|
129
|
-
|
|
130
|
-
Open VS Code, open Copilot Chat (`Ctrl+Shift+I` or `Cmd+Shift+I`), and type:
|
|
131
|
-
|
|
132
|
-
```
|
|
133
|
-
/map-codebase
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
Copilot will analyze your project and generate 7 structured documents in `.planning/codebase/`:
|
|
137
|
-
- `ARCHITECTURE.md` — layers, data flow, entry points
|
|
138
|
-
- `STRUCTURE.md` — where to put new code
|
|
139
|
-
- `CONVENTIONS.md` — coding style + naming rules
|
|
140
|
-
- `TESTING.md` — test framework + patterns
|
|
141
|
-
- `STACK.md` — runtime, dependencies, config
|
|
142
|
-
- `INTEGRATIONS.md` — external services
|
|
143
|
-
- `CONCERNS.md` — tech debt + fragile areas
|
|
144
|
-
|
|
145
|
-
**This takes 1-3 minutes.** After this, Copilot knows your codebase.
|
|
146
|
-
|
|
147
|
-
### Step 3: Set up your project
|
|
148
|
-
|
|
149
|
-
```
|
|
150
|
-
/new-project
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
Answer the guided questions. This fills in:
|
|
154
|
-
- `.planning/PROJECT.md` — what your project is and its core value
|
|
155
|
-
- `.planning/REQUIREMENTS.md` — requirements with IDs
|
|
156
|
-
- `.planning/ROADMAP.md` — phases with goals and success criteria
|
|
157
|
-
- `.planning/STATE.md` — current position
|
|
158
|
-
|
|
159
|
-
### Step 4: Start working
|
|
160
|
-
|
|
161
|
-
```
|
|
162
|
-
/plan-phase 1
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
That's it. You're set up.
|
|
166
|
-
|
|
167
|
-
---
|
|
168
|
-
|
|
169
|
-
## Daily Workflow
|
|
170
|
-
|
|
171
|
-
### Starting a session
|
|
172
|
-
|
|
173
|
-
```
|
|
174
|
-
/resume-work
|
|
175
|
-
```
|
|
176
|
-
Copilot reads your saved state and orients itself to where you left off.
|
|
177
|
-
|
|
178
|
-
### Planning work
|
|
179
|
-
|
|
180
|
-
Use the `/plan-phase` command or talk to the `@Planner` agent:
|
|
181
|
-
|
|
182
|
-
```
|
|
183
|
-
/plan-phase 2
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
Or switch to the Planner agent in the agents dropdown and describe what you need planned.
|
|
187
|
-
|
|
188
|
-
### Doing work
|
|
189
|
-
|
|
190
|
-
```
|
|
191
|
-
/execute-phase 2
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
Or switch to `@Executor`. It follows the plan, writes code, runs commands, and makes commits.
|
|
195
|
-
|
|
196
|
-
### Checking work
|
|
197
|
-
|
|
198
|
-
```
|
|
199
|
-
/verify-work 2
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
Or switch to `@Verifier`. It runs tests, checks the implementation against requirements, and reports gaps.
|
|
203
|
-
|
|
204
|
-
### Ending a session
|
|
205
|
-
|
|
206
|
-
```
|
|
207
|
-
/pause-work
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
This saves your current state to `.planning/continue-here.md` — what was done, what's remaining, decisions made, and the exact next action.
|
|
211
|
-
|
|
212
|
-
### Quick check
|
|
213
|
-
|
|
214
|
-
```
|
|
215
|
-
/progress
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
Shows overall project progress — which phases are done, what's next, requirement coverage.
|
|
219
|
-
|
|
220
|
-
---
|
|
221
|
-
|
|
222
|
-
## Slash Commands Reference
|
|
223
|
-
|
|
224
|
-
| Command | What it does | When to use |
|
|
225
|
-
|---------|-------------|-------------|
|
|
226
|
-
| `/map-codebase` | Analyzes your code → generates 7 context docs | First time setup, or after major refactors |
|
|
227
|
-
| `/new-project` | Guided project setup → fills `.planning/` docs | First time only |
|
|
228
|
-
| `/plan-phase [N]` | Creates a step-by-step plan for phase N | Before starting new work |
|
|
229
|
-
| `/execute-phase [N]` | Implements phase N following the plan | When plan is ready |
|
|
230
|
-
| `/verify-work [N]` | Checks phase N against requirements | After implementation |
|
|
231
|
-
| `/progress` | Shows project status and completion | Anytime — quick overview |
|
|
232
|
-
| `/pause-work` | Saves session state for later | End of work session |
|
|
233
|
-
| `/resume-work` | Loads saved state, orients session | Start of work session |
|
|
234
|
-
| `/sync-instructions` | Regenerates `copilot-instructions.md` | After updating `.planning/` docs |
|
|
235
|
-
| `/set-profile` | Switch AI model for all agents | When you want different quality/cost balance |
|
|
236
|
-
|
|
237
|
-
---
|
|
238
|
-
|
|
239
|
-
## Agents — Planner, Executor, Verifier
|
|
240
|
-
|
|
241
|
-
GSD provides three specialized agents. Each has a specific role and restricted tools to keep it focused.
|
|
242
|
-
|
|
243
|
-
### @Planner
|
|
244
|
-
|
|
245
|
-
- **Role:** Reads the codebase and requirements, produces detailed plans
|
|
246
|
-
- **Tools:** `search` only — **cannot edit files or run commands**
|
|
247
|
-
- **Model:** `claude-opus-4` (strongest reasoning)
|
|
248
|
-
- **Use when:** Starting a new phase, designing architecture, breaking down work
|
|
249
|
-
|
|
250
|
-
The Planner creates a plan document and then offers a handoff button: **"Start Executing"** → sends the plan to the Executor.
|
|
251
|
-
|
|
252
|
-
### @Executor
|
|
253
|
-
|
|
254
|
-
- **Role:** Implements the plan — writes code, runs tests, makes commits
|
|
255
|
-
- **Tools:** `editFiles`, `runTerminalCommand`, `search`
|
|
256
|
-
- **Model:** `claude-opus-4`
|
|
257
|
-
- **Use when:** Plan is ready and you want to implement it
|
|
258
|
-
|
|
259
|
-
After finishing, it offers: **"Verify This Work"** → sends to Verifier, or **"Pause & Save State"** → saves progress.
|
|
260
|
-
|
|
261
|
-
### @Verifier
|
|
262
|
-
|
|
263
|
-
- **Role:** Checks implementation against requirements — runs tests, inspects code
|
|
264
|
-
- **Tools:** `runTerminalCommand`, `search` — **cannot edit files**
|
|
265
|
-
- **Model:** `claude-sonnet-4`
|
|
266
|
-
- **Use when:** After implementing a phase, before merging
|
|
267
|
-
|
|
268
|
-
If gaps are found, it offers: **"Fix Gaps"** → sends back to Executor with specific issues.
|
|
269
|
-
|
|
270
|
-
### How to use agents
|
|
271
|
-
|
|
272
|
-
1. In Copilot Chat, click the agent dropdown (or type `@`)
|
|
273
|
-
2. Select **Planner**, **Executor**, or **Verifier**
|
|
274
|
-
3. Describe your task
|
|
275
|
-
4. Use the handoff buttons to chain agents together
|
|
276
|
-
|
|
277
|
-
**Typical flow:**
|
|
278
|
-
```
|
|
279
|
-
@Planner "Plan the authentication feature"
|
|
280
|
-
→ produces plan
|
|
281
|
-
→ click "Start Executing"
|
|
282
|
-
|
|
283
|
-
@Executor receives the plan
|
|
284
|
-
→ writes code, runs tests
|
|
285
|
-
→ click "Verify This Work"
|
|
286
|
-
|
|
287
|
-
@Verifier checks everything
|
|
288
|
-
→ "All requirements met" ✅
|
|
289
|
-
→ or "Fix Gaps" → back to Executor
|
|
290
|
-
```
|
|
291
|
-
|
|
292
|
-
You can also skip agents entirely and just use slash commands — they do the same thing inline.
|
|
293
|
-
|
|
294
|
-
---
|
|
295
|
-
|
|
296
|
-
## Model Profiles
|
|
297
|
-
|
|
298
|
-
Agents use specific AI models. The default is **quality** profile:
|
|
299
|
-
|
|
300
|
-
| Agent | Default Model |
|
|
301
|
-
|-------|--------------|
|
|
302
|
-
| Planner | `claude-opus-4` |
|
|
303
|
-
| Executor | `claude-opus-4` |
|
|
304
|
-
| Verifier | `claude-sonnet-4` |
|
|
305
|
-
|
|
306
|
-
### Switching profiles
|
|
307
|
-
|
|
308
|
-
Run `/set-profile` in Copilot Chat:
|
|
309
|
-
|
|
310
|
-
| Profile | Planner | Executor | Verifier | Best for |
|
|
311
|
-
|---------|---------|----------|----------|----------|
|
|
312
|
-
| **quality** | claude-opus-4 | claude-opus-4 | claude-sonnet-4 | Critical work, architecture decisions |
|
|
313
|
-
| **balanced** | claude-sonnet-4 | claude-sonnet-4 | claude-sonnet-4 | Normal development |
|
|
314
|
-
| **budget** | gpt-4.1 | gpt-4.1 | gpt-4.1-mini | High-volume, cost-sensitive |
|
|
315
|
-
| **gpt** | gpt-4.1 | gpt-4.1 | gpt-4.1 | Prefer OpenAI models |
|
|
316
|
-
|
|
317
|
-
`/set-profile` edits the `model:` field in all agent files and saves your choice to `.planning/config.json`.
|
|
318
|
-
|
|
319
|
-
### Per-agent override
|
|
320
|
-
|
|
321
|
-
You can also tell `/set-profile` to change just one agent:
|
|
322
|
-
```
|
|
323
|
-
/set-profile
|
|
324
|
-
> "Use opus for the verifier too, keep everything else on quality"
|
|
325
|
-
```
|
|
326
|
-
|
|
327
|
-
---
|
|
328
|
-
|
|
329
|
-
## How Instructions Work
|
|
330
|
-
|
|
331
|
-
> **You don't need to touch these** — they work automatically.
|
|
332
|
-
|
|
333
|
-
When you open a file or ask a question, Copilot loads relevant instructions behind the scenes:
|
|
334
|
-
|
|
335
|
-
| When you... | Copilot automatically loads |
|
|
336
|
-
|------------|---------------------------|
|
|
337
|
-
| Edit a `.ts`, `.js`, `.tsx`, `.jsx` file | `conventions.instructions.md` — your coding style |
|
|
338
|
-
| Edit a `*.test.ts`, `*.spec.js` file | `testing.instructions.md` — test patterns |
|
|
339
|
-
| Ask about architecture or backend | `architecture.instructions.md` |
|
|
340
|
-
| Ask where to put a new file | `structure.instructions.md` |
|
|
341
|
-
| Ask about dependencies or config | `stack.instructions.md` |
|
|
342
|
-
| Ask about external APIs or services | `integrations.instructions.md` |
|
|
343
|
-
| Work near tech debt or fragile code | `concerns.instructions.md` |
|
|
344
|
-
|
|
345
|
-
Each instruction file points to the detailed doc in `.planning/codebase/`. This keeps instructions small and context-efficient.
|
|
346
|
-
|
|
347
|
-
### Customizing for your language
|
|
348
|
-
|
|
349
|
-
If your project isn't TypeScript/JavaScript, edit `.github/instructions/conventions.instructions.md`:
|
|
350
|
-
|
|
351
|
-
```yaml
|
|
352
|
-
# Python
|
|
353
|
-
applyTo: "**/*.py"
|
|
354
|
-
|
|
355
|
-
# Java
|
|
356
|
-
applyTo: "**/*.{java,kt}"
|
|
357
|
-
|
|
358
|
-
# Go
|
|
359
|
-
applyTo: "**/*.go"
|
|
360
|
-
```
|
|
361
|
-
|
|
362
|
-
---
|
|
363
|
-
|
|
364
|
-
## The .planning/ Folder — Your Source of Truth
|
|
365
|
-
|
|
366
|
-
All project knowledge lives in `.planning/`. Copilot reads these automatically via the instructions system.
|
|
367
|
-
|
|
368
|
-
```
|
|
369
|
-
.planning/
|
|
370
|
-
├── PROJECT.md ← What this project is, who it's for, core constraints
|
|
371
|
-
├── REQUIREMENTS.md ← Feature requirements with IDs (AUTH-01, API-02)
|
|
372
|
-
├── ROADMAP.md ← Phase list: goals, steps, success criteria
|
|
373
|
-
├── STATE.md ← Current phase, progress, recent decisions
|
|
374
|
-
├── continue-here.md ← Session snapshot (written by /pause-work)
|
|
375
|
-
├── config.json ← Model profile + agent override settings
|
|
376
|
-
└── codebase/
|
|
377
|
-
├── ARCHITECTURE.md ← System layers, data flow, entry points
|
|
378
|
-
├── STRUCTURE.md ← Directory layout, where to put new code
|
|
379
|
-
├── CONVENTIONS.md ← Naming, formatting, error handling patterns
|
|
380
|
-
├── TESTING.md ← Test framework, patterns, what to test
|
|
381
|
-
├── STACK.md ← Runtime, frameworks, key dependencies
|
|
382
|
-
├── INTEGRATIONS.md ← External APIs, SDKs, service config
|
|
383
|
-
└── CONCERNS.md ← Tech debt, fragile areas, security notes
|
|
384
|
-
```
|
|
385
|
-
|
|
386
|
-
### What to commit
|
|
387
|
-
|
|
388
|
-
**Commit everything in `.planning/` and `.github/`.** This is shared project context — your whole team benefits when these are in the repo.
|
|
389
|
-
|
|
390
|
-
### When to regenerate
|
|
391
|
-
|
|
392
|
-
| Trigger | Action |
|
|
393
|
-
|---------|--------|
|
|
394
|
-
| Major refactor or new directory structure | `/map-codebase` |
|
|
395
|
-
| New external service integrated | Edit `.planning/codebase/INTEGRATIONS.md` or re-run `/map-codebase` |
|
|
396
|
-
| Phase completed | `/verify-work` then `/progress` to update state |
|
|
397
|
-
| Instructions feel stale | `/sync-instructions` |
|
|
398
|
-
|
|
399
|
-
---
|
|
400
|
-
|
|
401
|
-
## Session Continuity — How State Persists
|
|
402
|
-
|
|
403
|
-
Copilot doesn't have memory between sessions. GSD solves this with two files:
|
|
404
|
-
|
|
405
|
-
### `STATE.md` — living memory
|
|
406
|
-
|
|
407
|
-
Updated automatically by `/execute-phase` and `/pause-work`. Contains:
|
|
408
|
-
- Current phase and progress
|
|
409
|
-
- Recent decisions
|
|
410
|
-
- Active blockers
|
|
411
|
-
- Velocity metrics
|
|
412
|
-
|
|
413
|
-
### `continue-here.md` — exact resume point
|
|
414
|
-
|
|
415
|
-
Written by `/pause-work`. Contains:
|
|
416
|
-
- What was completed this session
|
|
417
|
-
- What remains
|
|
418
|
-
- Decisions that were locked
|
|
419
|
-
- The **exact next action** to take
|
|
420
|
-
|
|
421
|
-
### Resume flow
|
|
422
|
-
|
|
423
|
-
```
|
|
424
|
-
Start new session → /resume-work → Copilot reads both files → oriented in 5 seconds
|
|
425
|
-
```
|
|
426
|
-
|
|
427
|
-
If you have VS Code 1.109.3+ and enable hooks (`"chat.hooks.enabled": true`), state is injected automatically at session start — no `/resume-work` needed.
|
|
428
|
-
|
|
429
|
-
---
|
|
430
|
-
|
|
431
|
-
## Customizing for Your Project
|
|
432
|
-
|
|
433
|
-
### Add a new slash command
|
|
434
|
-
|
|
435
|
-
Create `.github/prompts/your-command.prompt.md`:
|
|
436
|
-
|
|
437
|
-
```yaml
|
|
438
|
-
---
|
|
439
|
-
name: your-command
|
|
440
|
-
description: What this command does
|
|
441
|
-
mode: agent
|
|
442
|
-
tools:
|
|
443
|
-
- editFiles
|
|
444
|
-
- search
|
|
445
|
-
---
|
|
446
|
-
|
|
447
|
-
# Your Command
|
|
448
|
-
|
|
449
|
-
Instructions for what Copilot should do when this command is invoked.
|
|
450
|
-
```
|
|
451
|
-
|
|
452
|
-
### Add a new instruction domain
|
|
453
|
-
|
|
454
|
-
Create `.github/instructions/your-topic.instructions.md`:
|
|
455
|
-
|
|
456
|
-
```yaml
|
|
457
|
-
---
|
|
458
|
-
name: Your Topic
|
|
459
|
-
description: When this context is relevant
|
|
460
|
-
applyTo: "**/*.sql"
|
|
461
|
-
---
|
|
462
|
-
|
|
463
|
-
# Rules for SQL files
|
|
464
|
-
|
|
465
|
-
- Use parameterized queries only
|
|
466
|
-
- ...
|
|
467
|
-
```
|
|
468
|
-
|
|
469
|
-
### Add a new agent
|
|
470
|
-
|
|
471
|
-
Create `.github/agents/your-agent.agent.md`:
|
|
472
|
-
|
|
473
|
-
```yaml
|
|
474
|
-
---
|
|
475
|
-
name: YourAgent
|
|
476
|
-
description: What this agent specializes in
|
|
477
|
-
tools:
|
|
478
|
-
- search
|
|
479
|
-
model: claude-sonnet-4
|
|
480
|
-
---
|
|
481
|
-
|
|
482
|
-
# Your Agent
|
|
483
|
-
|
|
484
|
-
Behavior instructions here.
|
|
485
|
-
```
|
|
486
|
-
|
|
487
|
-
---
|
|
488
|
-
|
|
489
|
-
## FAQ
|
|
490
|
-
|
|
491
|
-
**Q: Do I need to fill in every `.planning/` file manually?**
|
|
492
|
-
No. Run `/map-codebase` to auto-generate the 7 codebase docs, and `/new-project` to fill in project docs via guided questions. Only `PROJECT.md` benefits from some manual input.
|
|
493
|
-
|
|
494
|
-
**Q: What happens if I don't run `/pause-work`?**
|
|
495
|
-
Next session starts without saved state. Copilot can still read `.planning/` docs, but won't know exactly where you left off. Just run `/resume-work` and describe briefly what you were doing.
|
|
496
|
-
|
|
497
|
-
**Q: Can I use this with other AI tools?**
|
|
498
|
-
The `.planning/` docs are plain Markdown — any AI tool that reads files can use them. The `.github/` files (prompts, agents, instructions) are VS Code Copilot-specific.
|
|
499
|
-
|
|
500
|
-
**Q: Does this cost extra?**
|
|
501
|
-
No. This uses your existing GitHub Copilot subscription. Model selection (opus/sonnet/gpt) depends on your plan's model access.
|
|
502
|
-
|
|
503
|
-
**Q: How do I update GSD when new versions come out?**
|
|
504
|
-
```bash
|
|
505
|
-
npx ragarciaruben@latest copilot-context --force
|
|
506
|
-
```
|
|
507
|
-
|
|
508
|
-
**Q: Can multiple team members use this simultaneously?**
|
|
509
|
-
Yes. `.planning/` is committed to git. Everyone shares the same project context. Just be mindful of merge conflicts in `STATE.md` if two people `/pause-work` at the same time.
|
|
510
|
-
|
|
511
|
-
**Q: The agents don't appear in the dropdown?**
|
|
512
|
-
Reload VS Code: `Ctrl+Shift+P` → `Developer: Reload Window`. Agent files must be in `.github/agents/` (the default scan location).
|
|
513
|
-
|
|
514
|
-
**Q: Why are there duplicate files in `.github/agents/` and `.github/copilot-context/agents/`?**
|
|
515
|
-
`.github/agents/` is where VS Code actually reads them. `.github/copilot-context/agents/` is the reference copy that ships with the installer. The active ones are in `.github/agents/`.
|
|
516
|
-
|
|
517
|
-
---
|
|
518
|
-
|
|
519
|
-
## Compatibility
|
|
520
|
-
|
|
521
|
-
| Feature | Minimum VS Code Version |
|
|
522
|
-
|---------|------------------------|
|
|
523
|
-
| `copilot-instructions.md` (always-on) | Any recent version |
|
|
524
|
-
| `*.instructions.md` (conditional) | 1.102+ |
|
|
525
|
-
| `*.prompt.md` (slash commands) | 1.102+ |
|
|
526
|
-
| `*.agent.md` (agents + handoffs) | 1.106+ |
|
|
527
|
-
| `SessionStart` hooks | 1.109.3+ (Preview) |
|
|
528
|
-
|
|
529
|
-
---
|
|
530
|
-
|
|
531
|
-
## Quick Reference Card
|
|
532
|
-
|
|
533
|
-
```
|
|
534
|
-
SETUP:
|
|
535
|
-
npx ragarciaruben@latest copilot-context Install GSD
|
|
536
|
-
/map-codebase Analyze codebase (first time)
|
|
537
|
-
/new-project Set up project docs (first time)
|
|
538
|
-
|
|
539
|
-
DAILY:
|
|
540
|
-
/resume-work Start of session
|
|
541
|
-
/plan-phase N Plan phase N
|
|
542
|
-
/execute-phase N Implement phase N
|
|
543
|
-
/verify-work N Check phase N
|
|
544
|
-
/pause-work End of session
|
|
545
|
-
|
|
546
|
-
MAINTENANCE:
|
|
547
|
-
/progress Check overall status
|
|
548
|
-
/sync-instructions Refresh always-on digest
|
|
549
|
-
/set-profile Switch AI model profile
|
|
550
|
-
/map-codebase Re-analyze after big changes
|
|
551
|
-
|
|
552
|
-
AGENTS:
|
|
553
|
-
@Planner Plans (read-only)
|
|
554
|
-
@Executor Implements (full tools)
|
|
555
|
-
@Verifier Checks (read + run)
|
|
556
|
-
```
|
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: Executor
|
|
3
|
-
description: Implements planned phases — writes code, runs tests, and makes atomic commits following established conventions. Use me to execute a ready plan.
|
|
4
|
-
tools:
|
|
5
|
-
- editFiles
|
|
6
|
-
- runInTerminal
|
|
7
|
-
- search
|
|
8
|
-
- geppetto/*
|
|
9
|
-
- geppetto-api/*
|
|
10
|
-
- jira/*
|
|
11
|
-
model: Claude Opus 4.6
|
|
12
|
-
handoffs:
|
|
13
|
-
- label: Verify This Work
|
|
14
|
-
agent: Verifier
|
|
15
|
-
prompt: "Implementation is complete. Please verify the completed phase against the requirements in .planning/REQUIREMENTS.md and the phase success criteria in .planning/ROADMAP.md."
|
|
16
|
-
- label: Pause & Save State
|
|
17
|
-
agent: Pause
|
|
18
|
-
prompt: "Please save the current session state to .planning/continue-here.md so we can resume in a new session."
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
# Executor Agent
|
|
22
|
-
|
|
23
|
-
I am an implementation specialist. I execute plans precisely, follow established conventions, commit atomically, and verify with tests at every step.
|
|
24
|
-
|
|
25
|
-
## My Approach
|
|
26
|
-
|
|
27
|
-
1. **Load context first:** Before writing a single line of code, I read:
|
|
28
|
-
- The plan files in `.planning/phases/[current-phase]/`
|
|
29
|
-
- `.planning/codebase/CONVENTIONS.md` — coding standards
|
|
30
|
-
- `.planning/codebase/STRUCTURE.md` — where to place files
|
|
31
|
-
- `.planning/codebase/CONCERNS.md` — fragile areas to handle carefully
|
|
32
|
-
|
|
33
|
-
2. **Pre-flight check:** Run `npm test` to confirm baseline before I start
|
|
34
|
-
|
|
35
|
-
3. **Implement step by step:** Follow the plan's steps in order — no shortcuts, no improvising architecture
|
|
36
|
-
|
|
37
|
-
4. **Test continuously:** Run tests after each meaningful change; fix failures immediately
|
|
38
|
-
|
|
39
|
-
5. **Commit per plan:** After each plan is complete, commit with a descriptive message
|
|
40
|
-
|
|
41
|
-
6. **Update ROADMAP.md:** Mark completed plans with `[x]`
|
|
42
|
-
|
|
43
|
-
7. **Hand off to Verifier when done**
|
|
44
|
-
|
|
45
|
-
## My Rules
|
|
46
|
-
|
|
47
|
-
- **Never skip tests** — if a plan says "write tests", tests are written before moving to the next step
|
|
48
|
-
- **Never improvise architecture** — if the plan is unclear, ask before implementing
|
|
49
|
-
- **Follow conventions exactly** — refer to `.planning/codebase/CONVENTIONS.md` on every new file
|
|
50
|
-
- **Atomic commits** — one commit per completed plan, not per file
|
|
51
|
-
- **If I hit a blocker** — document it in `.planning/STATE.md`, save state, and surface it to you
|
|
52
|
-
|
|
53
|
-
## Jira Integration
|
|
54
|
-
|
|
55
|
-
When executing work tied to Jira tickets, I:
|
|
56
|
-
|
|
57
|
-
- **Read ticket details** with `mcp_jira_jira_get_issue` for acceptance criteria and context
|
|
58
|
-
- **Comment progress** with `mcp_jira_jira_add_comment` after completing significant steps
|
|
59
|
-
- **Transition tickets** with `mcp_jira_jira_transition_issue` (e.g., To Do → In Progress → In Review)
|
|
60
|
-
- Reference Jira ticket IDs in commit messages: `feat(PROJ-123): implement user auth flow`
|
|
61
|
-
|
|
62
|
-
## Trigger Phrases
|
|
63
|
-
|
|
64
|
-
"Execute phase [N]", "Implement the plan", "Build [feature] from the plan", "Continue implementing"
|
|
65
|
-
|
|
66
|
-
## Corporate Context (Geppetto MCP)
|
|
67
|
-
|
|
68
|
-
When implementing with corporate frameworks, APIs, or services, use the Geppetto MCP tools to look up Inditex-specific patterns:
|
|
69
|
-
|
|
70
|
-
- **`mcp_geppetto_generic_search`** — Search all Inditex technical documentation (best general-purpose fallback)
|
|
71
|
-
- **`mcp_geppetto_api_search`** — Search Inditex API best practices, guidelines, and REST API specifications
|
|
72
|
-
|
|
73
|
-
Use these tools when:
|
|
74
|
-
- Implementing against AMIGA framework patterns (Java, Node, Python, Go, Web)
|
|
75
|
-
- Calling or building corporate REST APIs
|
|
76
|
-
- Setting up CI/CD pipelines, Dockerfiles, or infrastructure config
|
|
77
|
-
- Implementing authorization flows (Heimdal) or other internal service integrations
|
|
78
|
-
|
|
79
|
-
## Reference Documents
|
|
80
|
-
|
|
81
|
-
- [.planning/codebase/CONVENTIONS.md](../../../.planning/codebase/CONVENTIONS.md) — coding standards
|
|
82
|
-
- [.planning/codebase/STRUCTURE.md](../../../.planning/codebase/STRUCTURE.md) — file placement
|
|
83
|
-
- [.planning/codebase/CONCERNS.md](../../../.planning/codebase/CONCERNS.md) — fragile areas
|
|
84
|
-
- [.planning/codebase/TESTING.md](../../../.planning/codebase/TESTING.md) — test patterns
|