@jakkrichm/create-nexus-devflow 2.0.25 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -8
- package/dist/bin/create-nexus-devflow.d.ts +22 -1
- package/dist/bin/create-nexus-devflow.js +658 -11
- package/dist/bin/create-nexus-devflow.js.map +1 -1
- package/dist/lib/branch-context.d.ts +39 -0
- package/dist/lib/branch-context.js +196 -0
- package/dist/lib/branch-context.js.map +1 -0
- package/dist/lib/code-graph.d.ts +30 -0
- package/dist/lib/code-graph.js +209 -0
- package/dist/lib/code-graph.js.map +1 -0
- package/dist/lib/command-catalog.d.ts +11 -0
- package/dist/lib/command-catalog.js +63 -0
- package/dist/lib/command-catalog.js.map +1 -0
- package/dist/lib/context-slicer.d.ts +31 -0
- package/dist/lib/context-slicer.js +234 -0
- package/dist/lib/context-slicer.js.map +1 -0
- package/dist/lib/current-work.js +97 -49
- package/dist/lib/current-work.js.map +1 -1
- package/dist/lib/dashboard-page.d.ts +2 -0
- package/dist/lib/dashboard-page.js +285 -0
- package/dist/lib/dashboard-page.js.map +1 -0
- package/dist/lib/dashboard-snapshot.d.ts +62 -0
- package/dist/lib/dashboard-snapshot.js +114 -0
- package/dist/lib/dashboard-snapshot.js.map +1 -0
- package/dist/lib/dashboard.d.ts +2 -0
- package/dist/lib/dashboard.js +398 -8
- package/dist/lib/dashboard.js.map +1 -1
- package/dist/lib/discoveries.d.ts +19 -0
- package/dist/lib/discoveries.js +81 -0
- package/dist/lib/discoveries.js.map +1 -0
- package/dist/lib/doctor.d.ts +26 -0
- package/dist/lib/doctor.js +474 -0
- package/dist/lib/doctor.js.map +1 -0
- package/dist/lib/drift-reconciler.d.ts +38 -0
- package/dist/lib/drift-reconciler.js +155 -0
- package/dist/lib/drift-reconciler.js.map +1 -0
- package/dist/lib/findings.d.ts +26 -2
- package/dist/lib/findings.js +165 -1
- package/dist/lib/findings.js.map +1 -1
- package/dist/lib/gatekeeper.d.ts +20 -0
- package/dist/lib/gatekeeper.js +106 -0
- package/dist/lib/gatekeeper.js.map +1 -0
- package/dist/lib/git-hooks.d.ts +16 -0
- package/dist/lib/git-hooks.js +103 -0
- package/dist/lib/git-hooks.js.map +1 -0
- package/dist/lib/history.d.ts +6 -1
- package/dist/lib/history.js +98 -11
- package/dist/lib/history.js.map +1 -1
- package/dist/lib/ide-extension.d.ts +38 -0
- package/dist/lib/ide-extension.js +61 -0
- package/dist/lib/ide-extension.js.map +1 -0
- package/dist/lib/ideas.d.ts +26 -0
- package/dist/lib/ideas.js +179 -0
- package/dist/lib/ideas.js.map +1 -0
- package/dist/lib/mcp.d.ts +36 -0
- package/dist/lib/mcp.js +653 -0
- package/dist/lib/mcp.js.map +1 -0
- package/dist/lib/status.d.ts +3 -1
- package/dist/lib/status.js +60 -6
- package/dist/lib/status.js.map +1 -1
- package/dist/lib/swarm-orchestrator.d.ts +31 -0
- package/dist/lib/swarm-orchestrator.js +134 -0
- package/dist/lib/swarm-orchestrator.js.map +1 -0
- package/dist/lib/update.js +2 -2
- package/dist/lib/update.js.map +1 -1
- package/dist/lib/version-check.d.ts +22 -0
- package/dist/lib/version-check.js +59 -0
- package/dist/lib/version-check.js.map +1 -0
- package/dist/lib/webview-studio.d.ts +8 -0
- package/dist/lib/webview-studio.js +463 -0
- package/dist/lib/webview-studio.js.map +1 -0
- package/dist/lib/workflow-state.d.ts +23 -0
- package/dist/lib/workflow-state.js +128 -0
- package/dist/lib/workflow-state.js.map +1 -0
- package/dist/scripts/prepare-template.js +3 -3
- package/package.json +1 -1
- package/template/{.claude/skills/00-discover → .agents/skills/00-explore}/SKILL.md +10 -10
- package/template/.agents/skills/10-define/SKILL.md +4 -4
- package/template/.agents/skills/20-spec/SKILL.md +2 -3
- package/template/.agents/skills/30-plan/SKILL.md +2 -3
- package/template/.agents/skills/40-execute/SKILL.md +2 -2
- package/template/.agents/skills/50-verify/SKILL.md +2 -2
- package/template/.agents/skills/60-report/SKILL.md +3 -3
- package/template/{.claude/skills/70-release → .agents/skills/70-deliver}/SKILL.md +7 -13
- package/template/.agents/skills/adopt/SKILL.md +136 -73
- package/template/.agents/skills/audit/SKILL.md +275 -0
- package/template/.agents/skills/autopilot/SKILL.md +228 -147
- package/template/.agents/skills/brainstorm/SKILL.md +3 -3
- package/template/.agents/skills/brief/SKILL.md +74 -51
- package/template/.agents/skills/check/SKILL.md +96 -76
- package/template/.agents/skills/ci/SKILL.md +140 -61
- package/template/.agents/skills/complete/SKILL.md +156 -101
- package/template/.agents/skills/convert-any-to-md/SKILL.md +2 -2
- package/template/.agents/skills/debug/SKILL.md +124 -49
- package/template/.agents/skills/devflow/SKILL.md +16 -10
- package/template/.agents/skills/discovery/SKILL.md +166 -0
- package/template/.agents/skills/doctor/SKILL.md +188 -72
- package/template/.agents/skills/feature/SKILL.md +195 -102
- package/template/.agents/skills/fix/SKILL.md +41 -90
- package/template/.agents/skills/idea/SKILL.md +3 -3
- package/template/.agents/skills/implement/SKILL.md +189 -46
- package/template/.agents/skills/onboard/SKILL.md +215 -85
- package/template/.agents/skills/overview/SKILL.md +51 -85
- package/template/.agents/skills/prototype/SKILL.md +82 -27
- package/template/.agents/skills/release/SKILL.md +160 -0
- package/template/.agents/skills/report-html/SKILL.md +2 -2
- package/template/.agents/skills/rollback/SKILL.md +123 -77
- package/template/.agents/skills/status/SKILL.md +109 -0
- package/template/.agents/skills/test/SKILL.md +2 -2
- package/template/.agents/skills/tests/SKILL.md +126 -0
- package/template/.agents/skills/try/SKILL.md +77 -65
- package/template/{.agents/skills/00-discover → .claude/skills/00-explore}/SKILL.md +9 -9
- package/template/.claude/skills/10-define/SKILL.md +2 -2
- package/template/.claude/skills/20-spec/SKILL.md +1 -1
- package/template/.claude/skills/30-plan/SKILL.md +1 -1
- package/template/.claude/skills/60-report/SKILL.md +1 -1
- package/template/{.agents/skills/70-release → .claude/skills/70-deliver}/SKILL.md +6 -12
- package/template/.claude/skills/adopt/SKILL.md +2 -2
- package/template/.claude/skills/audit/SKILL.md +141 -0
- package/template/.claude/skills/autopilot/SKILL.md +74 -52
- package/template/.claude/skills/brief/SKILL.md +67 -45
- package/template/.claude/skills/ci/SKILL.md +1 -1
- package/template/.claude/skills/complete/SKILL.md +1 -1
- package/template/.claude/skills/debug/SKILL.md +1 -1
- package/template/.claude/skills/devflow/SKILL.md +7 -7
- package/template/.claude/skills/discovery/SKILL.md +145 -0
- package/template/.claude/skills/doctor/SKILL.md +1 -1
- package/template/.claude/skills/feature/SKILL.md +67 -18
- package/template/.claude/skills/fix/SKILL.md +1 -1
- package/template/.claude/skills/idea/SKILL.md +2 -2
- package/template/.claude/skills/onboard/SKILL.md +3 -3
- package/template/.claude/skills/overview/SKILL.md +39 -88
- package/template/.claude/skills/prototype/SKILL.md +1 -1
- package/template/.claude/skills/release/SKILL.md +171 -0
- package/template/.claude/skills/rollback/SKILL.md +2 -2
- package/template/AGENTS.md +5 -5
- package/template/devflow/build-plan.md +62 -0
- package/template/devflow/context/ai-interaction.md +4 -4
- package/template/devflow/context/coding-standards.md +3 -3
- package/template/devflow/context/current-stage.md +1 -1
- package/template/devflow/context/findings.md +1 -1
- package/template/devflow/history/HISTORY.md +2 -2
- package/template/devflow/project-plan.md +79 -0
- package/template/devflow/reference/mockup.html +476 -0
- package/template/devflow/reference/project-overview-template.md +39 -0
- package/template/devflow/reference/running-id-contract.md +24 -2
- package/template/devflow/reference/studio.html +504 -0
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
|
-
name: 00-
|
|
3
|
-
description: "[
|
|
2
|
+
name: 00-explore
|
|
3
|
+
description: "[devflow][D] Explore stage in DevFlow 2.0 - explore a request, route supporting inquiry, and decide whether delivery work should begin without allocating a running ID."
|
|
4
4
|
argument-hint: "{title, request, or discovery-id}"
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
# Phase 00:
|
|
7
|
+
# Phase 00: Explore
|
|
8
8
|
|
|
9
9
|
$ARGUMENTS
|
|
10
10
|
|
|
@@ -13,15 +13,15 @@ Explore a request before delivery commitment. Create or resume a Discovery ID, c
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
15
15
|
```text
|
|
16
|
-
00-
|
|
17
|
-
00-
|
|
18
|
-
00-
|
|
16
|
+
00-explore {title or request}
|
|
17
|
+
00-explore IDEA-xxx
|
|
18
|
+
00-explore {discovery-id}
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Use this when:
|
|
22
22
|
|
|
23
23
|
- a new request needs discussion before the team commits to delivery
|
|
24
|
-
- exploring a pending idea from `devflow/ideas.md` (`00-
|
|
24
|
+
- exploring a pending idea from `devflow/ideas.md` (`00-explore IDEA-xxx`)
|
|
25
25
|
- the best route may be `Brainstorm`, `PRD`, `Research`, or `Debug`
|
|
26
26
|
- supporting findings need to be synthesized into a go/no-go decision
|
|
27
27
|
|
|
@@ -30,7 +30,7 @@ Use this when:
|
|
|
30
30
|
Write the primary discovery artifact to:
|
|
31
31
|
|
|
32
32
|
```text
|
|
33
|
-
devflow/discoveries/{DISCOVERY_ID}-{slug}/00-
|
|
33
|
+
devflow/discoveries/{DISCOVERY_ID}-{slug}/00-explore.md
|
|
34
34
|
```
|
|
35
35
|
|
|
36
36
|
A Discovery ID uses a separate namespace such as `DISC-YYYYMMDD-NNN`. It is not a Running ID and must not reserve a numeric delivery run.
|
|
@@ -74,11 +74,11 @@ Set one decision:
|
|
|
74
74
|
- `Defer`: the idea remains relevant but timing, evidence, or ownership is not ready
|
|
75
75
|
- `Reject`: the idea should not proceed under the current framing
|
|
76
76
|
|
|
77
|
-
### 3. Write `00-
|
|
77
|
+
### 3. Write `00-explore.md`
|
|
78
78
|
|
|
79
79
|
Record selected routes, returned findings, open questions, decision, and rationale.
|
|
80
80
|
|
|
81
81
|
## Next Workflow Recommendation
|
|
82
82
|
|
|
83
83
|
- **Primary**: `10-define {discovery_id}` only after approved Proceed
|
|
84
|
-
- **Defer/Reject**: No next command needed
|
|
84
|
+
- **Defer/Reject**: No next command needed
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: 10-define
|
|
3
|
-
description: "[
|
|
3
|
+
description: "[devflow][D] Define stage in DevFlow 2.0 - turn an approved discovery into a bounded delivery run in context/current-run with stable scope."
|
|
4
4
|
argument-hint: "{approved discovery-id, discovery path, running-id, or run path}"
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -37,13 +37,13 @@ using:
|
|
|
37
37
|
1. Inspect `devflow/context/current-stage.md`, `devflow/context/current-feature.md`, and `devflow/context/current-run/`.
|
|
38
38
|
2. If an active uncompleted run exists:
|
|
39
39
|
- **HALT and reject opening a new define stage**.
|
|
40
|
-
- Warn the user to complete or close the active run with `/complete` or `70-
|
|
40
|
+
- Warn the user to complete or close the active run with `/complete` or `70-deliver` first.
|
|
41
41
|
|
|
42
42
|
### 2. Validate The Discovery Gate
|
|
43
43
|
Require:
|
|
44
44
|
- `Decision: Proceed`
|
|
45
45
|
- `Approval Status: Approved`
|
|
46
|
-
- A resolvable Discovery ID and `00-
|
|
46
|
+
- A resolvable Discovery ID and `00-explore.md`
|
|
47
47
|
|
|
48
48
|
### 3. Allocate Sequential ID
|
|
49
49
|
- Inspect `devflow/history/HISTORY.md` and allocate sequential ID without prefix (e.g. `022-{slug}`).
|
|
@@ -51,4 +51,4 @@ Require:
|
|
|
51
51
|
- Write `devflow/context/current-run/10-define.md`.
|
|
52
52
|
- Update `devflow/context/current-stage.md`:
|
|
53
53
|
- `Active Running ID`: `{ID}`
|
|
54
|
-
- `Current Stage`: `10-define (Completed -> Ready for 20-spec)`
|
|
54
|
+
- `Current Stage`: `10-define (Completed -> Ready for 20-spec)`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: 20-spec
|
|
3
|
-
description: "[
|
|
3
|
+
description: "[devflow][D] Spec stage in DevFlow 2.0 - write the formal markdown-first specification from a stable definition."
|
|
4
4
|
argument-hint: "{running-id or workspace path}"
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -69,7 +69,7 @@ Run specification as a contract-hardening loop, not as a prose expansion of the
|
|
|
69
69
|
Read:
|
|
70
70
|
|
|
71
71
|
- `10-define.md`
|
|
72
|
-
- the shared `00-
|
|
72
|
+
- the shared `00-explore.md` referenced by `source_discovery` when the original framing still matters
|
|
73
73
|
- research notes if they impose real constraints
|
|
74
74
|
|
|
75
75
|
### 2. Write The Specification
|
|
@@ -153,4 +153,3 @@ Report:
|
|
|
153
153
|
- Use `Research` when a requirement, rule, or integration constraint still lacks evidence.
|
|
154
154
|
- Use `Spec-Research`, `Competitor`, or `PRD` when the contract needs stronger external, product, or market framing before planning.
|
|
155
155
|
- Use `grill-with-docs` when available if clarification could materially change acceptance criteria, edge cases, exclusions, or rules.
|
|
156
|
-
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: 30-plan
|
|
3
|
-
description: "[
|
|
3
|
+
description: "[devflow][D] Plan stage in DevFlow 2.0 - transform 20-spec.md into an executable task breakdown with test decisions."
|
|
4
4
|
---
|
|
5
5
|
# Phase 30: Plan Implementation
|
|
6
6
|
|
|
@@ -55,7 +55,7 @@ Run planning as an evidence loop, not as a one-shot outline.
|
|
|
55
55
|
Read:
|
|
56
56
|
|
|
57
57
|
- `devflow/runs/{ID}-*20-spec.md`
|
|
58
|
-
- `10-define.md` and the shared `00-
|
|
58
|
+
- `10-define.md` and the shared `00-explore.md` referenced by `source_discovery` when they help clarify intent
|
|
59
59
|
|
|
60
60
|
### 2. Assess Complexity
|
|
61
61
|
|
|
@@ -218,4 +218,3 @@ If `Approval Status` is still pending or major dependencies remain unresolved:
|
|
|
218
218
|
- **Reason**: Plans often discover stable patterns that future sessions should reuse.
|
|
219
219
|
- **Suggested Command**: `Wiki project ingest devflow/runs/{ID}-*30-plan.md`
|
|
220
220
|
|
|
221
|
-
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: 40-execute
|
|
3
|
-
description: "[
|
|
3
|
+
description: "[devflow][D] Execute stage in DevFlow 2.0 - execute planned tasks incrementally with evidence and unit tests."
|
|
4
4
|
---
|
|
5
5
|
# Phase 40: Execute Code
|
|
6
6
|
|
|
@@ -158,4 +158,4 @@ Report:
|
|
|
158
158
|
- **Needed**: `yes` when coding discovers a reusable implementation pattern, gotcha, or context optimization.
|
|
159
159
|
- **Scope**: `project` unless the discovery is about DevFlow itself.
|
|
160
160
|
- **Reason**: Coding findings are useful only when they are stable enough to help future tasks.
|
|
161
|
-
- **Suggested Command**: `Wiki project ingest devflow/runs/{ID}-*40-execute.md`
|
|
161
|
+
- **Suggested Command**: `Wiki project ingest devflow/runs/{ID}-*40-execute.md`
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: 50-verify
|
|
3
|
-
description: "[
|
|
3
|
+
description: "[devflow][D] Verify stage in DevFlow 2.0 - perform senior QA review, record evidence, and decide pass or return-to-implement."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Phase 50: Verify Quality
|
|
@@ -52,4 +52,4 @@ Execute verification across all essential quality dimensions:
|
|
|
52
52
|
Report:
|
|
53
53
|
- QA verdict across all verification lanes
|
|
54
54
|
- Evidence commands and outputs
|
|
55
|
-
- Next command: `60-report {ID}` (if pass) or `40-execute {ID}` (if fail)
|
|
55
|
+
- Next command: `60-report {ID}` (if pass) or `40-execute {ID}` (if fail)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: 60-report
|
|
3
|
-
description: "[
|
|
3
|
+
description: "[devflow][D] Report stage in DevFlow 2.0 - produce standardized markdown summary report with retrospective lessons learned."
|
|
4
4
|
argument-hint: "{running-id or workspace path}"
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -53,5 +53,5 @@ Structure the report in **Thai (`th`)**:
|
|
|
53
53
|
|
|
54
54
|
## Next Workflow Recommendation
|
|
55
55
|
|
|
56
|
-
- **Primary**: `70-
|
|
57
|
-
- **Optional Standalone HTML**: `/report:html`
|
|
56
|
+
- **Primary**: `70-deliver {ID}`
|
|
57
|
+
- **Optional Standalone HTML**: `/report:html`
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
|
-
name: 70-
|
|
3
|
-
description: "[
|
|
2
|
+
name: 70-deliver
|
|
3
|
+
description: "[devflow][D] Deliver stage in DevFlow 2.0 - package verified work for delivery, archive run to categorized history, git merge, PR, or deployment."
|
|
4
4
|
argument-hint: "{running-id or workspace path}"
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
# Phase 70:
|
|
7
|
+
# Phase 70: Deliver
|
|
8
8
|
|
|
9
9
|
$ARGUMENTS
|
|
10
10
|
|
|
@@ -13,7 +13,7 @@ Package approved work for delivery after the report stage has captured the final
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
15
15
|
```text
|
|
16
|
-
70-
|
|
16
|
+
70-deliver {id or workspace path}
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## Markdown-First Contract
|
|
@@ -21,20 +21,14 @@ Package approved work for delivery after the report stage has captured the final
|
|
|
21
21
|
Write the primary stage artifact to:
|
|
22
22
|
|
|
23
23
|
```text
|
|
24
|
-
devflow/context/current-run/70-
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
using:
|
|
28
|
-
|
|
29
|
-
```text
|
|
30
|
-
.agent/resources/schemas/release.template.md
|
|
24
|
+
devflow/context/current-run/70-deliver.md
|
|
31
25
|
```
|
|
32
26
|
|
|
33
27
|
## Process & Quality Gates
|
|
34
28
|
|
|
35
29
|
### 0. Step 0 Safety Pass & Findings Ledger Gate
|
|
36
30
|
|
|
37
|
-
Before packaging, merging, or
|
|
31
|
+
Before packaging, merging, or delivering:
|
|
38
32
|
|
|
39
33
|
1. **Findings Ledger Blockers**:
|
|
40
34
|
- Inspect `devflow/context/findings.md`.
|
|
@@ -75,4 +69,4 @@ Set `devflow/context/current-stage.md` to:
|
|
|
75
69
|
- `Active Running ID`: `None (Idle)`
|
|
76
70
|
- `Current Stage`: `Idle (Ready for new run)`
|
|
77
71
|
- `Last Completed Run`: `{ID} ({YYYY-MM-DD})`
|
|
78
|
-
- `Last Updated`: `{YYYY-MM-DD}`
|
|
72
|
+
- `Last Updated`: `{YYYY-MM-DD}`
|
|
@@ -1,95 +1,158 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: adopt
|
|
3
|
-
description: "[
|
|
3
|
+
description: "[devflow][B] Bring the blueprint into an existing (brownfield) codebase. Surveys the real repo, interviews for intent, generates the owned plans and coding standards, documents existing verification and CI, and points to the optional standalone CI setup. Use when the user runs /adopt, is overlaying the blueprint onto an app that already has meaningful code, or asks to adopt or bootstrap the workflow into an existing project. For freshly scaffolded or early projects, use onboard instead."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# adopt -
|
|
6
|
+
# adopt - bootstrap the blueprint from an existing codebase
|
|
7
7
|
|
|
8
8
|
Where this sits in the workflow:
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
interview) shipped architecture documented) delivery lifecycle)
|
|
14
|
-
```
|
|
10
|
+
existing codebase -> [adopt] -> project-plan + build-plan + coding-standards -> /overview -> normal loop
|
|
11
|
+
(already has code) (survey + (seeded from the real code; shipped (project- (/feature,
|
|
12
|
+
interview) features already checked off) overview.md) /implement, ...)
|
|
15
13
|
|
|
16
|
-
|
|
14
|
+
The standard onboarding assumes a freshly scaffolded, near-empty app: you write
|
|
15
|
+
the two plans from scratch and build forward. That doesn't fit a project that
|
|
16
|
+
already has thousands of lines of working code. `/adopt` is the brownfield
|
|
17
|
+
on-ramp: it reads what's already there, asks you only for what the code can't tell
|
|
18
|
+
it (the *why* and the *roadmap*), and produces the same input files the rest of
|
|
19
|
+
the workflow expects - so an existing project joins the loop without you
|
|
20
|
+
hand-writing everything.
|
|
17
21
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
---
|
|
22
|
+
It generates the inputs; it does not generate `project-overview.md`. That stays
|
|
23
|
+
`/overview`'s job. `/adopt` ends by telling you to run `/overview`.
|
|
21
24
|
|
|
22
25
|
## Input
|
|
23
26
|
|
|
24
|
-
A description of what the project is, if
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
- If they
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
Never
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
27
|
+
A description of what the project is, if the user offers one. Otherwise just the
|
|
28
|
+
repository itself. No argument is required.
|
|
29
|
+
|
|
30
|
+
## Step 0 - confirm it's brownfield and safe
|
|
31
|
+
|
|
32
|
+
Look at `devflow/project-plan.md` and `devflow/build-plan.md`.
|
|
33
|
+
|
|
34
|
+
- If they're missing or still the empty worksheet/placeholder, proceed.
|
|
35
|
+
- If they already hold real content, this project is already adopted. Stop and say
|
|
36
|
+
so; offer to refresh a specific file instead of overwriting work the user owns.
|
|
37
|
+
|
|
38
|
+
Never overwrite a filled-in plan without explicit confirmation. Never run a
|
|
39
|
+
framework scaffolder (the blueprint is an overlay, never a generator).
|
|
40
|
+
|
|
41
|
+
Protect the project README:
|
|
42
|
+
|
|
43
|
+
- If the root `README.md` already looks like a real project README, leave it
|
|
44
|
+
alone.
|
|
45
|
+
- If the root `README.md` is the copied Blueprint workflow doc (for example it
|
|
46
|
+
starts with `# AI Coding Blueprint`), report it as obsolete overlay content
|
|
47
|
+
and ask before replacing or removing it. Do not move it into `blueprint/`.
|
|
48
|
+
- Do not create or overwrite a root project README for a brownfield app unless
|
|
49
|
+
the user explicitly asks. The existing project face belongs to the app, not the
|
|
50
|
+
workflow.
|
|
51
|
+
|
|
52
|
+
## Step 1 - survey the codebase (read-only)
|
|
53
|
+
|
|
54
|
+
Read the repo to establish the facts. Change nothing in this step. Establish:
|
|
55
|
+
|
|
56
|
+
- **Stack and tooling** - language(s), framework(s), and versions, from the real
|
|
57
|
+
manifest (`package.json`, `requirements.txt`, `pyproject.toml`, `go.mod`,
|
|
58
|
+
`Gemfile`, `Cargo.toml`, etc.). Note the package manager actually in use (lockfile).
|
|
59
|
+
- **Commands** - the real dev / build / test / lint scripts. These feed the
|
|
60
|
+
Commands section of `AGENTS.md` and, per the testing opt-in switch, decide
|
|
61
|
+
whether a testing gate even applies.
|
|
62
|
+
- **Conventions in practice** - directory layout, component/file naming, styling
|
|
63
|
+
approach, state management, data-fetching pattern, error handling. Read what the
|
|
64
|
+
code *does*, not what a default template prescribes.
|
|
65
|
+
- **Testing reality** - is a runner configured and are there tests, or none? Be
|
|
66
|
+
honest; don't describe a gate the project doesn't have.
|
|
67
|
+
- **Verification and CI** - note any combined verification command, GitHub
|
|
68
|
+
remote, `.github/workflows/`, or external CI. Preserve what already exists.
|
|
69
|
+
- **What the app already does** - the shipped features, inferred from routes,
|
|
70
|
+
pages, entry points, and modules. This becomes the *checked* part of the build plan.
|
|
71
|
+
|
|
72
|
+
Keep notes; you'll turn them into the files in Step 3.
|
|
73
|
+
|
|
74
|
+
## Step 2 - interview for intent
|
|
75
|
+
|
|
76
|
+
The code reveals *what* and *how*, never *why* or *what next*. Ask the user a short
|
|
77
|
+
set of questions (aim for three to five, not an interrogation) to fill the gaps:
|
|
78
|
+
|
|
79
|
+
- What is this project for, and who uses it? (the problem and the users)
|
|
80
|
+
- Is the stack and structure you found intentional, or are there parts they'd call
|
|
81
|
+
legacy / want to change?
|
|
82
|
+
- What do you want to build next? (the unchecked items in the build plan)
|
|
83
|
+
- Anything the survey got wrong or missed?
|
|
84
|
+
|
|
85
|
+
If the user already gave intent up front, skip what they've answered. Don't ask
|
|
86
|
+
what you can read from the code.
|
|
87
|
+
|
|
88
|
+
## Step 3 - generate the inputs
|
|
89
|
+
|
|
90
|
+
Write these, drawn from the survey (facts) and the interview (intent). Mark every
|
|
91
|
+
inference you're unsure of with a clear `> TODO (confirm)` so the user can correct
|
|
92
|
+
it rather than inherit a wrong guess.
|
|
93
|
+
|
|
94
|
+
- **`devflow/project-plan.md`** - the what & why, following the existing
|
|
95
|
+
worksheet structure (problem, users, features, data, tech, monetization, UI/UX).
|
|
96
|
+
The "features" and "tech" sections describe what *already exists*; the rest comes
|
|
97
|
+
from the interview.
|
|
98
|
+
- **`devflow/build-plan.md`** - the ordered feature list as a checklist. **Mark
|
|
99
|
+
shipped features `- [x]`** (this is the brownfield difference: the build plan
|
|
100
|
+
reflects reality, so most of an existing app starts checked) and the roadmap
|
|
101
|
+
items from the interview as `- [ ]`. This makes `/status` and `/feature` work
|
|
102
|
+
immediately - the next unchecked item is genuinely what's next.
|
|
103
|
+
- **`devflow/context/coding-standards.md`** - rewrite the default to match the
|
|
104
|
+
project's *actual* conventions from Step 1, not the shipped Next.js/Prisma
|
|
105
|
+
defaults. Keep the Writing and Comments sections; replace the stack-specific ones
|
|
106
|
+
with what the code really does. Its Testing section must reflect the real testing
|
|
107
|
+
state (the opt-in switch is a `test` command in `AGENTS.md`).
|
|
108
|
+
- **`AGENTS.md` Commands section** - fill in the real dev / build / test / lint
|
|
109
|
+
commands you found, so the rest of the workflow (and the testing gate) uses the
|
|
110
|
+
project's actual scripts. Include `Verify` when a real combined command exists.
|
|
111
|
+
|
|
112
|
+
Do not write `project-overview.md`; that's `/overview`'s job, downstream of these.
|
|
113
|
+
|
|
114
|
+
## Step 4 - point to optional CI setup
|
|
115
|
+
|
|
116
|
+
Do not create or change Verify commands or GitHub workflows during adoption.
|
|
117
|
+
Report any verification command or CI already present. When equivalent automatic
|
|
118
|
+
pull-request checks are absent, mention the optional standalone setup:
|
|
40
119
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
- **Commands**: Real dev, build, test, lint, and verify scripts.
|
|
45
|
-
- **Conventions in Practice**: Directory layout, component naming, state management, styling, data-fetching, error handling, validation. Read what the code *actually does*.
|
|
46
|
-
- **Testing Reality**: Inspect existing test suites, runners, and coverage. Be honest about test status.
|
|
47
|
-
- **Shipped Capabilities & Architecture**: Inferred from routes, pages, controllers, database schemas, and entry points.
|
|
48
|
-
|
|
49
|
-
Keep structured notes for generation in Step 3.
|
|
50
|
-
|
|
51
|
-
---
|
|
52
|
-
|
|
53
|
-
## Step 2 - Interview for Intent
|
|
54
|
-
|
|
55
|
-
The code reveals *what* and *how*, but not *why* or *what next*. Ask a short set of 3-4 questions to fill the gaps:
|
|
56
|
-
|
|
57
|
-
1. **Purpose & Users**: What is the core problem this project solves, and who are the target users?
|
|
58
|
-
2. **Architecture Status**: Is the current structure and stack intentional, or are there legacy parts/technical debt the team wants to change or refactor?
|
|
59
|
-
3. **Upcoming Roadmap**: What are the top priorities to build, fix, or refactor next?
|
|
60
|
-
4. **Clarifications**: Anything the survey got wrong or missed?
|
|
61
|
-
|
|
62
|
-
*(If the user already provided this context in the prompt, skip questions that are already answered).*
|
|
63
|
-
|
|
64
|
-
---
|
|
120
|
+
```text
|
|
121
|
+
Run /ci or $ci when you want automatic GitHub checks.
|
|
122
|
+
```
|
|
65
123
|
|
|
66
|
-
|
|
124
|
+
Explain that CI is not required to finish adoption. The `/ci` skill owns
|
|
125
|
+
project-specific Verify and GitHub workflow setup.
|
|
67
126
|
|
|
68
|
-
|
|
127
|
+
## Step 5 - review gate, then hand off
|
|
69
128
|
|
|
70
|
-
|
|
71
|
-
- Project Name, Purpose, and Target Users
|
|
72
|
-
- Architecture summary and directory layout
|
|
73
|
-
- Shipped capabilities and existing major modules
|
|
74
|
-
- Key technical stack components and verified commands
|
|
75
|
-
- Known technical debt or architectural focus areas
|
|
129
|
+
Stop and show the user what you generated, calling out:
|
|
76
130
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
131
|
+
- the **build-plan split** - what you marked shipped vs not, since that's the
|
|
132
|
+
judgment most worth their eyes,
|
|
133
|
+
- every `> TODO (confirm)` you left,
|
|
134
|
+
- anything the survey and the interview disagreed on,
|
|
135
|
+
- verification command and GitHub checks status.
|
|
80
136
|
|
|
81
|
-
|
|
82
|
-
|
|
137
|
+
These files are the ones the user *owns*. Have them review and adjust, then tell
|
|
138
|
+
them to run `/overview` to distill the plans into `project-overview.md` and start
|
|
139
|
+
the normal loop.
|
|
83
140
|
|
|
84
|
-
|
|
141
|
+
## Rules
|
|
85
142
|
|
|
86
|
-
|
|
143
|
+
- **Read-only until Step 3.** The survey changes nothing; only generation writes.
|
|
144
|
+
- **Reflect reality, don't prescribe.** `coding-standards.md` must match the code
|
|
145
|
+
that exists. A project using Zustand and REST routes should not be handed
|
|
146
|
+
standards about Server Actions and Prisma just because that's the default.
|
|
147
|
+
- **Never invent intent.** Ask for the why and the roadmap; mark anything inferred
|
|
148
|
+
with `> TODO (confirm)`. Silent guesses about purpose are the main failure mode.
|
|
149
|
+
- **Don't clobber owned work.** If the plans already have real content, confirm
|
|
150
|
+
before touching them. Never run a scaffolder.
|
|
151
|
+
- **Be honest about testing.** If there's no runner, say testing is opt-in and not
|
|
152
|
+
yet set up; don't describe a gate the project hasn't adopted.
|
|
87
153
|
|
|
88
|
-
|
|
154
|
+
## Formatting
|
|
89
155
|
|
|
90
|
-
|
|
91
|
-
-
|
|
92
|
-
|
|
93
|
-
- Recommended next step:
|
|
94
|
-
- Run `00-discover` (or `00-discover`, `$00-discover`) to explore the next major initiative or feature
|
|
95
|
-
- Run `10-define` (or `10-define`, `$10-define`) to immediately scope a delivery run for known roadmap items
|
|
156
|
+
Format the output to match the project's conventions in
|
|
157
|
+
`devflow/context/ai-interaction.md`: concise, scannable markdown, with lists for
|
|
158
|
+
enumerations and tables for matrices rather than dense paragraphs.
|