jumpstart-mode 1.0.5 → 1.0.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/agents/jumpstart-analyst.agent.md +14 -6
- package/.github/agents/jumpstart-architect.agent.md +15 -7
- package/.github/agents/jumpstart-challenger.agent.md +22 -5
- package/.github/agents/jumpstart-developer.agent.md +12 -2
- package/.github/agents/jumpstart-pm.agent.md +15 -7
- package/.github/copilot-instructions.md +2 -0
- package/.jumpstart/agents/analyst.md +16 -4
- package/.jumpstart/agents/architect.md +21 -7
- package/.jumpstart/agents/challenger.md +40 -6
- package/.jumpstart/agents/developer.md +12 -2
- package/.jumpstart/agents/pm.md +66 -7
- package/.jumpstart/commands/commands.md +27 -22
- package/.jumpstart/config.yaml +8 -5
- package/.jumpstart/templates/architecture.md +6 -6
- package/.jumpstart/templates/challenger-brief.md +19 -12
- package/.jumpstart/templates/implementation-plan.md +3 -3
- package/.jumpstart/templates/insights.md +18 -18
- package/.jumpstart/templates/prd.md +160 -3
- package/.jumpstart/templates/product-brief.md +2 -2
- package/AGENTS.md +87 -19
- package/README.md +44 -18
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -1,28 +1,96 @@
|
|
|
1
1
|
# Jump Start Framework -- Agent Instructions
|
|
2
2
|
|
|
3
|
-
This repository
|
|
3
|
+
> **System Notice:** This repository is managed by the Jump Start spec-driven framework. All AI agents operating in this context must adhere strictly to the protocols defined below.
|
|
4
4
|
|
|
5
|
-
## Workflow
|
|
5
|
+
## Workflow Overview
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
The development lifecycle follows five strict, sequential phases. No phase may begin until the previous phase's artifact is **explicitly approved** by the human operator.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
9
|
+
```mermaid
|
|
10
|
+
flowchart TB
|
|
11
|
+
P0[Phase 0: Challenge] -->|Brief| P1[Phase 1: Analyze]
|
|
12
|
+
P1 -->|Product Brief| P2[Phase 2: Plan]
|
|
13
|
+
P2 -->|PRD| P3[Phase 3: Architect]
|
|
14
|
+
P3 -->|Specs| P4[Phase 4: Build]
|
|
15
|
+
|
|
16
|
+
C(Challenger) -.-> P0
|
|
17
|
+
A(Analyst) -.-> P1
|
|
18
|
+
PM(Product Manager) -.-> P2
|
|
19
|
+
Arch(Architect) -.-> P3
|
|
20
|
+
Dev(Developer) -.-> P4
|
|
16
21
|
|
|
17
|
-
|
|
22
|
+
style P0 fill:#1976d2,stroke:#333,stroke-width:2px,color:#fff
|
|
23
|
+
style P4 fill:#43a047,stroke:#333,stroke-width:2px,color:#fff
|
|
24
|
+
```
|
|
18
25
|
|
|
19
|
-
|
|
20
|
-
2. **Agent fidelity.** When operating as a specific agent, load and follow `.jumpstart/agents/<agent>.md` exactly.
|
|
21
|
-
3. **Human gates.** Never auto-approve phase transitions. Always present the artifact and ask for explicit approval.
|
|
22
|
-
4. **Templates.** Use `.jumpstart/templates/` for all artifact structures.
|
|
23
|
-
5. **Config.** Read `.jumpstart/config.yaml` at the start of every phase.
|
|
24
|
-
6. **Artifact locations.** Specs go in `specs/`. ADRs in `specs/decisions/`. Code in `src/`. Tests in `tests/`.
|
|
26
|
+
## Agent Directory
|
|
25
27
|
|
|
26
|
-
|
|
28
|
+
| Phase | Agent Persona | Activation Command | Primary Responsibility | Output Artifact |
|
|
29
|
+
| --- | --- | --- | --- | --- |
|
|
30
|
+
| **0** | **The Challenger** | `/jumpstart.challenge` | Interrogates the problem, finds root causes, reframes assumptions. | `specs/challenger-brief.md` |
|
|
31
|
+
| **1** | **The Analyst** | `/jumpstart.analyze` | Defines personas, user journeys, and MVP scope. | `specs/product-brief.md` |
|
|
32
|
+
| **2** | **The PM** | `/jumpstart.plan` | Writes user stories, acceptance criteria, and NFRs. | `specs/prd.md` |
|
|
33
|
+
| **3** | **The Architect** | `/jumpstart.architect` | Selects tech stack, models data, designs APIs, plans tasks. | `specs/architecture.md`<br>
|
|
27
34
|
|
|
28
|
-
|
|
35
|
+
<br>`specs/implementation-plan.md` |
|
|
36
|
+
| **4** | **The Developer** | `/jumpstart.build` | Writes code and tests according to the plan. | `src/`, `tests/`, `README.md` |
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Operational Protocols
|
|
41
|
+
|
|
42
|
+
All agents must follow these directives without exception.
|
|
43
|
+
|
|
44
|
+
### 1. The Context Protocol
|
|
45
|
+
|
|
46
|
+
* **Read Before Write:** Before generating any content, you must read `.jumpstart/config.yaml` and the specific agent instruction file in `.jumpstart/agents/`.
|
|
47
|
+
* **Upstream Traceability:** You must read the *approved* artifacts from previous phases.
|
|
48
|
+
* *Analyst* reads *Challenger Brief*.
|
|
49
|
+
* *Architect* reads *PRD*, *Product Brief*, and *Challenger Brief*.
|
|
50
|
+
* Do not hallucinate requirements that contradict upstream documents.
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### 2. The Execution Protocol
|
|
55
|
+
|
|
56
|
+
* **Stay in Lane:**
|
|
57
|
+
* The **Challenger** never suggests solutions or technologies.
|
|
58
|
+
* The **Analyst** never writes code or defines database schemas.
|
|
59
|
+
* The **Developer** never changes the architecture without flagging a deviation.
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
* **Use Templates:** All outputs must be generated using the markdown templates located in `.jumpstart/templates/`. Do not invent new document formats.
|
|
63
|
+
* **Living Insights:** Simultaneously maintain your phase's `insights.md` file to log your reasoning, trade-offs, and discarded alternatives.
|
|
64
|
+
|
|
65
|
+
### 3. The Gate Protocol
|
|
66
|
+
|
|
67
|
+
* **No Auto-Approval:** You cannot mark a phase as complete. You must present the final artifact to the human and ask: *"Does this meet your expectations?"*
|
|
68
|
+
* **Checkboxes Matter:** An artifact is only considered "Approved" when:
|
|
69
|
+
1. The `Phase Gate Approval` section at the bottom of the file is filled.
|
|
70
|
+
2. All checkboxes in that section are marked `[x]`.
|
|
71
|
+
3. The "Approved by" field is not "Pending".
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### 4. The Artifact Protocol
|
|
76
|
+
|
|
77
|
+
* **Specs Location:** All documentation goes into `specs/`.
|
|
78
|
+
* **Decisions:** Significant technical choices must be recorded in `specs/decisions/` as ADRs.
|
|
79
|
+
* **Source Code:** Application code goes into `src/`.
|
|
80
|
+
* **Tests:** Test code goes into `tests/`.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Tool Usage (VS Code Copilot)
|
|
85
|
+
|
|
86
|
+
If running within VS Code Copilot, agents have access to native UI tools:
|
|
87
|
+
|
|
88
|
+
* **`ask_questions`:** Use this to present multiple-choice decisions to the user (e.g., selecting a tech stack or prioritizing a feature).
|
|
89
|
+
* **`manage_todo_list`:** Use this to display a dynamic progress bar for your phase's protocol (e.g., "Step 3 of 8: User Journey Mapping").
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Troubleshooting
|
|
94
|
+
|
|
95
|
+
* **Missing Context:** If an upstream artifact is missing (e.g., running `/jumpstart.plan` before Phase 1 is done), **stop** and instruct the user to complete the missing phase first.
|
|
96
|
+
* **Ambiguity:** If a requirement is unclear, ask the user for clarification using the `ask_questions` tool rather than guessing.
|
package/README.md
CHANGED
|
@@ -1,22 +1,48 @@
|
|
|
1
|
-
# Jump Start
|
|
1
|
+
# ⚡ Jump Start
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+

|
|
4
|
+

|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
**A spec-driven agentic coding framework that transforms a raw idea into production-ready code through five sequential, AI-governed phases.**
|
|
8
|
+
|
|
9
|
+
Every artifact lives in your repository, version-controlled, diffable, and transparent.
|
|
4
10
|
|
|
5
11
|
---
|
|
6
12
|
|
|
7
|
-
##
|
|
13
|
+
## Table of Contents
|
|
14
|
+
- [How It Works](#how-it-works)
|
|
15
|
+
- [Prerequisites](#prerequisites)
|
|
16
|
+
- [Quick Start](#quick-start)
|
|
17
|
+
- [Example Workflow](#example-workflow)
|
|
18
|
+
- [Commands](#commands)
|
|
19
|
+
- [Configuration](#configuration)
|
|
20
|
+
- [Project Structure](#project-structure)
|
|
21
|
+
- [Living Insights](#living-insights)
|
|
22
|
+
- [VS Code Chat Features](#vs-code-chat-features)
|
|
23
|
+
- [Troubleshooting](#troubleshooting)
|
|
8
24
|
|
|
9
|
-
|
|
25
|
+
---
|
|
10
26
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
27
|
+
## How It Works
|
|
28
|
+
|
|
29
|
+
Jump Start runs five phases in a strict sequence. Each phase is owned by a specialized AI agent and produces Markdown artifacts that serve as the input for the next phase. A human gate sits between every transition to ensure quality.
|
|
30
|
+
|
|
31
|
+
```mermaid
|
|
32
|
+
flowchart TB
|
|
33
|
+
P0[Phase 0: Challenge] -->|Brief| P1[Phase 1: Analyze]
|
|
34
|
+
P1 -->|Product Brief| P2[Phase 2: Plan]
|
|
35
|
+
P2 -->|PRD| P3[Phase 3: Architect]
|
|
36
|
+
P3 -->|Specs| P4[Phase 4: Build]
|
|
37
|
+
|
|
38
|
+
C(Challenger) -.-> P0
|
|
39
|
+
A(Analyst) -.-> P1
|
|
40
|
+
PM(Product Manager) -.-> P2
|
|
41
|
+
Arch(Architect) -.-> P3
|
|
42
|
+
Dev(Developer) -.-> P4
|
|
43
|
+
|
|
44
|
+
style P0 fill:#1976d2,stroke:#333,stroke-width:2px,color:#fff
|
|
45
|
+
style P4 fill:#43a047,stroke:#333,stroke-width:2px,color:#fff
|
|
20
46
|
```
|
|
21
47
|
|
|
22
48
|
**Phase 0 -- Problem Discovery.** The Challenger agent interrogates your idea, surfaces hidden assumptions, drills to root causes, and produces a validated problem statement.
|
|
@@ -93,7 +119,7 @@ This creates the full directory structure, all agent definitions, templates, and
|
|
|
93
119
|
|
|
94
120
|
### 2. Configure
|
|
95
121
|
|
|
96
|
-
Edit `.jumpstart/config.yaml` to customise agent
|
|
122
|
+
Edit `.jumpstart/config.yaml` to customise agent behavior, story format, prioritization method, and other settings. The file is self-documenting with inline comments.
|
|
97
123
|
|
|
98
124
|
### 3. Run
|
|
99
125
|
|
|
@@ -225,7 +251,7 @@ Insights live in `specs/insights/` with a 1:1 relationship to primary artifacts:
|
|
|
225
251
|
specs/insights/
|
|
226
252
|
├── challenger-brief-insights.md # Phase 0: Problem discovery reasoning
|
|
227
253
|
├── product-brief-insights.md # Phase 1: Analysis explorations and trade-offs
|
|
228
|
-
├── prd-insights
|
|
254
|
+
├── prd-insights.md # Phase 2: Planning decisions and story prioritization
|
|
229
255
|
├── architecture-insights.md # Phase 3: Technical choices and design trade-offs
|
|
230
256
|
└── implementation-plan-insights.md # Phase 4: Implementation learnings and gotchas
|
|
231
257
|
```
|
|
@@ -320,14 +346,14 @@ This creates a **two-way knowledge graph** between formal specs and informal rea
|
|
|
320
346
|
|
|
321
347
|
## Configuration
|
|
322
348
|
|
|
323
|
-
The `.jumpstart/config.yaml` file controls framework
|
|
349
|
+
The `.jumpstart/config.yaml` file controls framework behavior. Key settings:
|
|
324
350
|
|
|
325
351
|
**Workflow:**
|
|
326
352
|
- `require_gate_approval`: Enforce human approval between phases (default: true)
|
|
327
353
|
- `allow_phase_skip`: Allow jumping to later phases (default: false)
|
|
328
354
|
|
|
329
355
|
**Agents:**
|
|
330
|
-
- Each agent has configurable settings (elicitation depth, story format,
|
|
356
|
+
- Each agent has configurable settings (elicitation depth, story format, prioritization method, diagram format, test framework, etc.)
|
|
331
357
|
|
|
332
358
|
**Integrations:**
|
|
333
359
|
- `ai_assistant`: Which AI tool you're using (copilot, claude-code, cursor, gemini, windsurf)
|
|
@@ -466,7 +492,7 @@ vscode_tools:
|
|
|
466
492
|
### Adding Custom Agents
|
|
467
493
|
|
|
468
494
|
Create a new agent file in `.jumpstart/agents/` following the pattern of the existing agents:
|
|
469
|
-
- Define the agent's identity, mandate, and
|
|
495
|
+
- Define the agent's identity, mandate, and behavioral guidelines
|
|
470
496
|
- Specify its input context (which artifacts it reads)
|
|
471
497
|
- Define its protocol (step-by-step instructions)
|
|
472
498
|
- Specify its output (which artifacts it produces)
|
package/package.json
CHANGED