@jakkrichm/create-nexus-devflow 2.0.13 → 2.0.14
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/dist/bin/create-nexus-devflow.d.ts +2 -0
- package/dist/bin/create-nexus-devflow.js +233 -0
- package/dist/bin/create-nexus-devflow.js.map +1 -0
- package/dist/lib/starter-templates.d.ts +6 -0
- package/dist/lib/starter-templates.js +8 -0
- package/dist/lib/starter-templates.js.map +1 -0
- package/dist/lib/update.d.ts +68 -0
- package/dist/lib/update.js +325 -0
- package/dist/lib/update.js.map +1 -0
- package/dist/scripts/clean-template.d.ts +1 -0
- package/dist/scripts/clean-template.js +14 -0
- package/dist/scripts/clean-template.js.map +1 -0
- package/dist/scripts/prepare-template.d.ts +1 -0
- package/dist/scripts/prepare-template.js +89 -0
- package/dist/scripts/prepare-template.js.map +1 -0
- package/package.json +11 -9
- package/template/.agents/skills/00-discover/SKILL.md +2 -0
- package/template/.agents/skills/60-report/SKILL.md +21 -75
- package/template/.agents/skills/70-release/SKILL.md +5 -4
- package/template/.agents/skills/check/SKILL.md +68 -0
- package/template/.agents/skills/complete/SKILL.md +73 -0
- package/template/.agents/skills/devflow/SKILL.md +89 -80
- package/template/.agents/skills/idea/SKILL.md +57 -0
- package/template/.agents/skills/implement/SKILL.md +64 -0
- package/template/.agents/skills/overview/SKILL.md +114 -0
- package/template/.agents/skills/report-html/SKILL.md +45 -0
- package/template/.agents/skills/spec/SKILL.md +105 -0
- package/template/.claude/skills/00-discover/SKILL.md +2 -0
- package/template/.claude/skills/60-report/SKILL.md +21 -75
- package/template/.claude/skills/70-release/SKILL.md +5 -4
- package/template/.claude/skills/check/SKILL.md +68 -0
- package/template/.claude/skills/complete/SKILL.md +73 -0
- package/template/.claude/skills/devflow/SKILL.md +89 -80
- package/template/.claude/skills/idea/SKILL.md +57 -0
- package/template/.claude/skills/implement/SKILL.md +64 -0
- package/template/.claude/skills/overview/SKILL.md +114 -0
- package/template/.claude/skills/report-html/SKILL.md +45 -0
- package/template/.claude/skills/spec/SKILL.md +105 -0
- package/template/AGENTS.md +71 -74
- package/template/devflow/context/ai-interaction.md +1 -0
- package/template/devflow/context/coding-standards.md +31 -18
- package/template/devflow/context/current-stage.md +3 -3
- package/template/devflow/context/findings.md +10 -6
- package/template/devflow/context/project-overview.md +29 -11
- package/template/devflow/discoveries/.gitkeep +0 -0
- package/template/devflow/history/HISTORY.md +4 -0
- package/template/devflow/ideas.md +15 -0
- package/template/devflow/runs/.gitkeep +0 -0
- package/bin/create-nexus-devflow.js +0 -287
- package/lib/starter-templates.js +0 -111
- package/lib/update.js +0 -393
- package/template/.nexus/nexus-devflow.json +0 -44
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: implement
|
|
3
|
+
description: "[Devflow] Fast-Track Implement stage in DevFlow (Blueprint Mode) - execute checklist tasks incrementally with TDD and update spec.md."
|
|
4
|
+
argument-hint: "{running-id or workspace path}"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Fast-Track: Implement (Blueprint Mode)
|
|
8
|
+
|
|
9
|
+
$ARGUMENTS
|
|
10
|
+
|
|
11
|
+
Incremental code execution stage in Fast-Track. Reads the Single Living Spec (`spec.md`), executes checklist tasks, implements tests (TDD), and updates the implementation record.
|
|
12
|
+
|
|
13
|
+
## Invocations & Aliases
|
|
14
|
+
|
|
15
|
+
- `/implement`: Run implementation on current active run
|
|
16
|
+
- `/implement {running-id}`: Run implementation on specified running ID
|
|
17
|
+
- `$implement`: Codex CLI invocation
|
|
18
|
+
|
|
19
|
+
## Fast-Track Mainline Workflow
|
|
20
|
+
|
|
21
|
+
```text
|
|
22
|
+
/spec ──▶ /implement ──▶ /check ──▶ /complete
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Behavior & Contract
|
|
26
|
+
|
|
27
|
+
When invoked:
|
|
28
|
+
|
|
29
|
+
### 1. Load Active Context
|
|
30
|
+
1. Identify active Running ID from `devflow/context/current-stage.md` or argument.
|
|
31
|
+
2. Read `devflow/runs/{RUNNING_ID}/spec.md`.
|
|
32
|
+
3. Locate `## 2. Plan & Test Strategy` and `## 3. Implementation Checklist`.
|
|
33
|
+
|
|
34
|
+
### 2. Incremental Execution with TDD
|
|
35
|
+
1. Select unchecked items `- [ ]` from the checklist in order.
|
|
36
|
+
2. For each task:
|
|
37
|
+
- **TDD (Red-Green-Refactor)**: When `Test Decision: Required`, create or update unit tests first.
|
|
38
|
+
- Implement the minimal, clean code change satisfying the task.
|
|
39
|
+
- Run localized verification (e.g. `npm test`, linter).
|
|
40
|
+
- Mark the item as `- [x]` in `spec.md`.
|
|
41
|
+
|
|
42
|
+
### 3. Update Living Spec (`spec.md`)
|
|
43
|
+
Append or update `## 4. Implementation Record` in `spec.md` with:
|
|
44
|
+
- Summary of completed tasks and modified files
|
|
45
|
+
- Key architectural observations or notes
|
|
46
|
+
- Status of checklist items
|
|
47
|
+
|
|
48
|
+
Example:
|
|
49
|
+
```markdown
|
|
50
|
+
## 4. Implementation Record
|
|
51
|
+
- **[Task 1.1]**: Implemented JWT auth middleware in `src/middleware/auth.ts`
|
|
52
|
+
- **[Task 1.2]**: Added unit tests in `test/auth.test.ts` (All 6 tests passing)
|
|
53
|
+
- **[Task 1.3]**: Registered auth route in `src/server.ts`
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### 4. Update Workspace Status
|
|
57
|
+
Update `devflow/context/current-stage.md`:
|
|
58
|
+
- `Current Stage`: `implement (Fast-Track -> Checklist Completed -> Ready for /check)`
|
|
59
|
+
|
|
60
|
+
### 5. Output Summary & Next Step
|
|
61
|
+
Report to the user:
|
|
62
|
+
- Completed checklist items and modified files
|
|
63
|
+
- Local verification results
|
|
64
|
+
- **Next Command**: `/check` (or `/check {RUNNING_ID}`)
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: overview
|
|
3
|
+
description: "[Devflow] Scan codebase architecture, data models, and shipped history to synthesize or refresh devflow/context/project-overview.md as the living source of truth."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# overview - Living Context Synthesis & Sync
|
|
7
|
+
|
|
8
|
+
Where this sits in the workflow:
|
|
9
|
+
|
|
10
|
+
```text
|
|
11
|
+
codebase + devflow/history/HISTORY.md -> [overview] -> devflow/context/project-overview.md -> 00-discover / 10-define / 20-spec
|
|
12
|
+
(reality & shipped runs) (sync & (living source of truth) (informed planning)
|
|
13
|
+
synthesize)
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
`overview` is the context synchronization and synthesis engine for Nexus-DevFlow. It inspects the actual codebase (manifest, dependencies, directory layout, models/schemas, entry points) along with the completed delivery history (`devflow/history/HISTORY.md` and `devflow/runs/`) to build or refresh `devflow/context/project-overview.md`.
|
|
17
|
+
|
|
18
|
+
It ensures that `project-overview.md` remains a **Living Source of Truth** that evolves alongside your software, rather than a stale artifact left behind after onboarding.
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
/overview
|
|
24
|
+
$overview
|
|
25
|
+
overview
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Use this when:
|
|
29
|
+
- Multiple delivery runs (`RUN-xxx`) have shipped and `project-overview.md` needs to reflect newly added capabilities.
|
|
30
|
+
- New database schemas, ORM models, or API boundaries were introduced.
|
|
31
|
+
- Major dependencies or architectural patterns were added or modified.
|
|
32
|
+
- After completing `70-release` to keep project context perfectly aligned.
|
|
33
|
+
- Preparing for a new initiative or discovery pass.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Process
|
|
38
|
+
|
|
39
|
+
### Step 1 - Scan Reality (Codebase Survey)
|
|
40
|
+
|
|
41
|
+
Inspect the actual codebase to establish hard facts:
|
|
42
|
+
|
|
43
|
+
1. **Manifest & Tooling**:
|
|
44
|
+
- Read `package.json`, `pyproject.toml`, `go.mod`, `Cargo.toml`, `pom.xml`, or `Gemfile`.
|
|
45
|
+
- Identify language versions, primary framework, state management, and build tools.
|
|
46
|
+
2. **Directory Architecture**:
|
|
47
|
+
- Map high-level directory layout (`src/`, `app/`, `api/`, `lib/`, `components/`, etc.).
|
|
48
|
+
- Identify major modules, entry points, and routing conventions.
|
|
49
|
+
3. **Concrete Data Models & Schemas**:
|
|
50
|
+
- Search for ORM schemas (`schema.prisma`, Drizzle schemas, TypeORM entities, SQLAlchemy models, Zod schemas, or core TypeScript types).
|
|
51
|
+
- Extract entity names, core fields, relationships, and invariants.
|
|
52
|
+
4. **Verified Commands**:
|
|
53
|
+
- Inspect package scripts (`dev`, `build`, `test`, `lint`, `check`, `verify`).
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
### Step 2 - Scan History (Delivered Capabilities)
|
|
58
|
+
|
|
59
|
+
Inspect DevFlow history records:
|
|
60
|
+
|
|
61
|
+
1. Read `devflow/history/HISTORY.md` for completed and released milestones.
|
|
62
|
+
2. Scan completed delivery runs in `devflow/runs/` to extract shipped user-visible capabilities and core system features.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
### Step 3 - Synthesize `project-overview.md`
|
|
67
|
+
|
|
68
|
+
Write or update `devflow/context/project-overview.md` following standard structure:
|
|
69
|
+
|
|
70
|
+
```markdown
|
|
71
|
+
# Project Overview & Source of Truth
|
|
72
|
+
|
|
73
|
+
> Living context artifact automatically synchronized with codebase reality and DevFlow delivery history.
|
|
74
|
+
|
|
75
|
+
## 1. Project Purpose & Target Users
|
|
76
|
+
- High-level summary of what the system does, who it serves, and the core problem it solves.
|
|
77
|
+
|
|
78
|
+
## 2. Architecture & Directory Layout
|
|
79
|
+
- Visual directory layout tree with short descriptions for major modules and boundaries.
|
|
80
|
+
|
|
81
|
+
## 3. Technology Stack & Key Tooling
|
|
82
|
+
- Frontend, Backend, Database, ORM, Testing frameworks, CI/CD, and Package Manager.
|
|
83
|
+
|
|
84
|
+
## 4. Concrete Data Models & Entities
|
|
85
|
+
- Field-level definitions of major entities, types, and relationships.
|
|
86
|
+
|
|
87
|
+
## 5. Shipped Capabilities & Key Modules
|
|
88
|
+
- Consolidated list of active features and subsystems verified in the codebase.
|
|
89
|
+
|
|
90
|
+
## 6. Verified Commands & Developer Workflow
|
|
91
|
+
- Exact commands for Dev, Build, Test, Lint, and Verify.
|
|
92
|
+
|
|
93
|
+
## 7. Known Architectural Focus Areas
|
|
94
|
+
- Known technical debt, active migrations, or upcoming architectural focus points.
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
### Step 4 - Review & Report
|
|
100
|
+
|
|
101
|
+
Present a concise summary of the sync:
|
|
102
|
+
- Models or entities detected and added
|
|
103
|
+
- Shipped capabilities refreshed from history
|
|
104
|
+
- Stack and tooling updates
|
|
105
|
+
- Any inconsistencies or gaps found between code and documentation
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Rules & Guardrails
|
|
110
|
+
|
|
111
|
+
1. **Grounded in Reality**: Never invent non-existent packages, fictional data models, or unverified endpoints. Everything in `project-overview.md` must be traceable to real code or recorded history.
|
|
112
|
+
2. **Preserve User Intent**: Do not erase custom business rules or user-written notes. Integrate new facts smoothly around existing intent.
|
|
113
|
+
3. **Concrete Over Vague**: Provide actual model names, field types, and route paths rather than vague one-line summaries.
|
|
114
|
+
4. **Non-Destructive**: `overview` only writes to `devflow/context/project-overview.md`. It never modifies source code, runs migrations, or touches git history.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: report-html
|
|
3
|
+
description: "[Devflow] Standalone HTML Report Generator - render an interactive standalone HTML dashboard from spec.md or 60-report.md on demand."
|
|
4
|
+
argument-hint: "{running-id or workspace path}"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Standalone: Report HTML
|
|
8
|
+
|
|
9
|
+
$ARGUMENTS
|
|
10
|
+
|
|
11
|
+
Standalone companion command to generate an interactive, self-contained HTML report dashboard on demand from either a Fast-Track `spec.md` or a Deep-Track `60-report.md`.
|
|
12
|
+
|
|
13
|
+
> [!NOTE]
|
|
14
|
+
> HTML reports are **never automatically generated** during normal mainline stages (`/complete` or `60-report`). Use this command whenever you or stakeholders wish to view or share an interactive web report.
|
|
15
|
+
|
|
16
|
+
## Invocations & Aliases
|
|
17
|
+
|
|
18
|
+
- `/report:html`: Generate HTML report for the active or most recent run
|
|
19
|
+
- `/report:html {running-id}`: Generate HTML report for the specified running ID
|
|
20
|
+
- `npm run report:html -- {running-id}`: CLI npm script invocation
|
|
21
|
+
- `$report:html`: Codex CLI invocation
|
|
22
|
+
|
|
23
|
+
## Behavior & Contract
|
|
24
|
+
|
|
25
|
+
When invoked:
|
|
26
|
+
|
|
27
|
+
### 1. Identify Target Run
|
|
28
|
+
1. Locate target run directory in `devflow/runs/{running-id}` from argument or `devflow/context/current-stage.md`.
|
|
29
|
+
2. Check for either:
|
|
30
|
+
- Fast-Track Living Spec: `devflow/runs/{RUNNING_ID}/spec.md` (or `blueprint.md`)
|
|
31
|
+
- Deep-Track Report Digest: `devflow/runs/{RUNNING_ID}/60-report.md`
|
|
32
|
+
|
|
33
|
+
### 2. Render Interactive HTML Dashboard
|
|
34
|
+
Execute the HTML generation engine:
|
|
35
|
+
```bash
|
|
36
|
+
npm run report:html -- {RUNNING_ID}
|
|
37
|
+
```
|
|
38
|
+
Or execute the renderer to transform Markdown into a styled, standalone HTML document:
|
|
39
|
+
- Path: `devflow/runs/{RUNNING_ID}/report.html`
|
|
40
|
+
|
|
41
|
+
### 3. Output
|
|
42
|
+
Provide:
|
|
43
|
+
- Generated HTML file path: `file:///devflow/runs/{RUNNING_ID}/report.html`
|
|
44
|
+
- Summary of sections rendered (Spec, Plan, Progress, QA Evidence, Release Notes)
|
|
45
|
+
- Instructions to open the file in any browser
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: spec
|
|
3
|
+
description: "[Devflow] Fast-Track Spec stage in DevFlow (Blueprint Mode) - define, spec, plan, and create the single living spec.md contract."
|
|
4
|
+
argument-hint: "{feature title, bug description, IDEA-xxx, or running-id}"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Fast-Track: Spec (Blueprint Mode)
|
|
8
|
+
|
|
9
|
+
$ARGUMENTS
|
|
10
|
+
|
|
11
|
+
Fast-Track entry point combining Discovery, Definition, Specification, and Implementation Planning into one streamlined, review-gated step. Creates and maintains the **Single Living Spec (`spec.md`)** for the run. Supports intake from Idea Inbox (`IDEA-xxx`).
|
|
12
|
+
|
|
13
|
+
## Invocations & Aliases
|
|
14
|
+
|
|
15
|
+
- `/spec <title>` or `spec <title>`: Standard Fast-Track specification
|
|
16
|
+
- `/spec IDEA-xxx`: Intake and promote a pending idea from `devflow/ideas.md`
|
|
17
|
+
- `/feature <title>` or `feature <title>`: Fast-Track feature workflow
|
|
18
|
+
- `/fix <bug-description>` or `fix <bug-description>`: Fast-Track ad-hoc bugfix workflow
|
|
19
|
+
- `$spec`, `$feature`, `$fix`: Codex CLI invocation
|
|
20
|
+
|
|
21
|
+
## Fast-Track Mainline Workflow
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
/spec ──▶ /implement ──▶ /check ──▶ /complete
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Behavior & Contract
|
|
28
|
+
|
|
29
|
+
When invoked:
|
|
30
|
+
|
|
31
|
+
### 1. Work Identity & Idea Intake
|
|
32
|
+
1. Inspect `devflow/context/current-stage.md` and `devflow/runs/`.
|
|
33
|
+
2. **Idea Inbox Intake**: If the argument is an idea identifier (e.g. `IDEA-001`):
|
|
34
|
+
- Read `devflow/ideas.md` and extract the idea's title, raw problem statement, AI Feasibility notes, and Quick Seed points.
|
|
35
|
+
- Use these details as the primary input for Specification & Scope.
|
|
36
|
+
- In `devflow/ideas.md`, update the item's status to `[x] Claimed ({RUNNING_ID})` and move it under `## 📦 Archived / Shipped Ideas`.
|
|
37
|
+
3. Determine or allocate the sequential Running ID (e.g. `RUN-016-{slug}`).
|
|
38
|
+
4. Identify Git branch naming:
|
|
39
|
+
- For features: `feature/{slug}-{RUNNING_ID}`
|
|
40
|
+
- For bug fixes: `fix/{slug}-{RUNNING_ID}`
|
|
41
|
+
5. Create directory `devflow/runs/{RUNNING_ID}/`.
|
|
42
|
+
|
|
43
|
+
### 2. Generate the Single Living Spec (`spec.md`)
|
|
44
|
+
Write `devflow/runs/{RUNNING_ID}/spec.md` using the structured template below in **Thai (`th`)**:
|
|
45
|
+
|
|
46
|
+
```markdown
|
|
47
|
+
# 📐 [{RUNNING_ID}] {Title} (Living Spec)
|
|
48
|
+
|
|
49
|
+
> **Status**: In-Progress
|
|
50
|
+
> **Track**: Fast-Track (Blueprint Mode)
|
|
51
|
+
> **Branch**: `{branch_name}`
|
|
52
|
+
> **Created Date**: {YYYY-MM-DD}
|
|
53
|
+
> **Owner**: {Contributor or Team}
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## 1. Specification & Scope
|
|
58
|
+
- **Problem Statement**: {ปัญหาหรือที่มาที่ต้องทำ}
|
|
59
|
+
- **In-Scope**:
|
|
60
|
+
- {ขอบเขตสิ่งที่ต้องทำ}
|
|
61
|
+
- **Out-of-Scope**:
|
|
62
|
+
- {สิ่งที่ไม่ทำในรอบนี้}
|
|
63
|
+
- **Acceptance Criteria**:
|
|
64
|
+
- [ ] AC-1: {เงื่อนไขการตรวจรับข้อที่ 1}
|
|
65
|
+
- [ ] AC-2: {เงื่อนไขการตรวจรับข้อที่ 2}
|
|
66
|
+
|
|
67
|
+
## 2. Plan & Test Strategy
|
|
68
|
+
- **Files to Modify / Create**:
|
|
69
|
+
- `{path/to/file1}`: {หน้าที่ที่ต้องแก้ไข}
|
|
70
|
+
- `{path/to/file2}`: {หน้าที่ที่ต้องแก้ไข}
|
|
71
|
+
- **Test Decision**: `Required (TDD)` | `Manual/Command Only` | `Not Required`
|
|
72
|
+
- *Rationale*: {เหตุผลความจำเป็นในการเขียนเทสต์}
|
|
73
|
+
- *Planned Cases*: {กรณีทดสอบหลักตาม AAA Pattern}
|
|
74
|
+
- **Impact & Rollback Strategy**:
|
|
75
|
+
- *Impact*: {ผลกระทบต่อโมดูลอื่น}
|
|
76
|
+
- *Rollback*: {วิธีย้อนคืนการทำงานกรณีเกิดปัญหา}
|
|
77
|
+
|
|
78
|
+
## 3. Implementation Checklist
|
|
79
|
+
- [ ] Task 1.1: {งานย่อยข้อที่ 1}
|
|
80
|
+
- [ ] Task 1.2: {งานย่อยข้อที่ 2}
|
|
81
|
+
- [ ] Task 1.3: {งานย่อยข้อที่ 3}
|
|
82
|
+
|
|
83
|
+
## 4. Implementation Record
|
|
84
|
+
- *(จะถูกบันทึกเมื่อรัน /implement)*
|
|
85
|
+
|
|
86
|
+
## 5. Verification Evidence
|
|
87
|
+
- *(จะถูกบันทึกเมื่อรัน /check)*
|
|
88
|
+
|
|
89
|
+
## 6. Release & Handoff
|
|
90
|
+
- *(จะถูกบันทึกเมื่อรัน /complete)*
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### 3. Update Workspace Status
|
|
94
|
+
Update `devflow/context/current-stage.md`:
|
|
95
|
+
- `Active Running ID`: `{RUNNING_ID}`
|
|
96
|
+
- `Current Stage`: `spec (Fast-Track -> Ready for /implement)`
|
|
97
|
+
- `Last Updated`: `{YYYY-MM-DD}`
|
|
98
|
+
|
|
99
|
+
### 4. Output Summary & Next Step
|
|
100
|
+
Report to the user:
|
|
101
|
+
- Running ID and allocated branch
|
|
102
|
+
- Summary of Scope and Acceptance Criteria
|
|
103
|
+
- Living Spec path: `devflow/runs/{RUNNING_ID}/spec.md`
|
|
104
|
+
- If promoted from `IDEA-xxx`, confirm status update in `devflow/ideas.md`
|
|
105
|
+
- **Next Command**: `/implement` (or `/implement {RUNNING_ID}`)
|
package/template/AGENTS.md
CHANGED
|
@@ -1,10 +1,14 @@
|
|
|
1
|
-
# Nexus-DevFlow 2.0 (
|
|
1
|
+
# Nexus-DevFlow 2.0 (Dual-Track Blueprint & Architect Model)
|
|
2
2
|
|
|
3
3
|
Instructions for AI coding agents working in this project. This is the cross-tool entry point: Codex, Google Antigravity, Cursor, GitHub Copilot, Gemini CLI, Aider, Zed, Windsurf, and others read `AGENTS.md`. Claude Code reads `CLAUDE.md`, which imports this file (`@AGENTS.md`), so there is a single source of truth.
|
|
4
4
|
|
|
5
5
|
## What this is
|
|
6
6
|
|
|
7
|
-
This project uses **Nexus-DevFlow**, an agentic
|
|
7
|
+
This project uses **Nexus-DevFlow**, an agentic workflow layer supporting **Dual-Track Delivery**:
|
|
8
|
+
1. **🏎️ Fast-Track (Blueprint Mode - 4 Steps)**: High-velocity spec-driven loop driven by a **Single Living Spec (`spec.md`)**.
|
|
9
|
+
2. **🏗️ Deep-Track (Architect Mode - 8 Steps)**: Full-lifecycle delivery pipeline with modular stage artifacts (`00-70`).
|
|
10
|
+
|
|
11
|
+
To start a new project, scaffold the application first in an empty folder, then run `npx @jakkrichm/create-nexus-devflow` to overlay DevFlow onto your codebase.
|
|
8
12
|
|
|
9
13
|
## Read these for full context
|
|
10
14
|
|
|
@@ -25,66 +29,70 @@ Unused adapter families can be removed. Codex and Antigravity projects keep `.ag
|
|
|
25
29
|
|
|
26
30
|
### Universal Invocation & Agent Directives:
|
|
27
31
|
|
|
28
|
-
1. **Canonical Command Names & AI Provider Invocation**: Each workflow stage and companion tool has exactly **one Canonical Name** (e.g. `00-discover`, `10-define`, `20-spec`, `30-plan`, `40-implement`, `50-verify`, `60-report`, `70-release`, `devflow`, `onboard`, `adopt`, `doctor`, `try`, `rollback`, `ci`, `brief`, `autopilot`). The way you invoke commands depends on your AI Provider / Tool:
|
|
29
|
-
- **Canonical Name (Plain text)**: Directly invoke or prompt the command by its standard name (e.g., `
|
|
30
|
-
- **Slash Prefix (`/`)**: For tools supporting slash commands (Claude Code, Google Antigravity, Gemini CLI), e.g., `/
|
|
31
|
-
- **Dollar Prefix (`$`)**: For OpenAI Codex CLI or skill-invocation tools, e.g., `$
|
|
32
|
+
1. **Canonical Command Names & AI Provider Invocation**: Each workflow stage and companion tool has exactly **one Canonical Name** (e.g. `spec`, `implement`, `check`, `complete`, `00-discover`, `10-define`, `20-spec`, `30-plan`, `40-implement`, `50-verify`, `60-report`, `70-release`, `report-html`, `devflow`, `onboard`, `adopt`, `doctor`, `try`, `rollback`, `ci`, `brief`, `autopilot`). The way you invoke commands depends on your AI Provider / Tool:
|
|
33
|
+
- **Canonical Name (Plain text)**: Directly invoke or prompt the command by its standard name (e.g., `spec`, `devflow`).
|
|
34
|
+
- **Slash Prefix (`/`)**: For tools supporting slash commands (Claude Code, Google Antigravity, Gemini CLI), e.g., `/spec`, `/feature`, `/fix`, `/devflow`.
|
|
35
|
+
- **Dollar Prefix (`$`)**: For OpenAI Codex CLI or skill-invocation tools, e.g., `$spec`, `$devflow`.
|
|
32
36
|
2. **OpenAI Codex & Non-Native CLI Tools**: In environments without automatic background skill discovery (such as OpenAI Codex CLI, Aider, or generic terminals), **you MUST use your file reading tool to inspect `.agents/skills/<skill>/SKILL.md` before executing the stage** to strictly follow its schema, artifact contract, and quality gates.
|
|
33
37
|
3. **Google Antigravity & Claude Code**: Native skill engines automatically discover and surface `.agents/skills/` and `.claude/skills/`.
|
|
34
38
|
4. **State-Aware Inspection**: When unsure what to do next, invoke `devflow` to automatically inspect `devflow/context/current-stage.md` and active runs in `devflow/runs/`.
|
|
35
|
-
5. **Default Artifact & Communication Language (Thai)**: All generated markdown stage artifacts (`
|
|
39
|
+
5. **Default Artifact & Communication Language (Thai)**: All generated markdown stage artifacts (`spec.md`, `00-discover.md`...`70-release.md`) and user communication MUST default to **Thai (`th`)**, while code, technical terms, file paths, and identifiers remain in English.
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 🏎️ Track 1: Fast-Track (Blueprint Mode - 4 Steps)
|
|
36
44
|
|
|
37
|
-
|
|
45
|
+
Recommended for 85% of daily work (features, bug fixes, UI improvements, iterative tasks):
|
|
38
46
|
|
|
39
47
|
```text
|
|
40
|
-
|
|
48
|
+
/spec (or /feature, /fix) ──▶ /implement ──▶ /check ──▶ /complete
|
|
41
49
|
```
|
|
42
50
|
|
|
43
|
-
|
|
51
|
+
1. **`spec` (`/spec`, `/feature`, `/fix`)**:
|
|
52
|
+
- **Purpose**: Combines Discover, Define, Spec, and Plan into one unified step. Allocates sequential Running ID (`RUN-xxx`) and creates the **Single Living Spec (`spec.md`)**.
|
|
53
|
+
- **Artifact**: `devflow/runs/{running-id}-{slug}/spec.md`
|
|
54
|
+
2. **`implement` (`/implement`)**:
|
|
55
|
+
- **Purpose**: Incrementally executes checklist tasks with TDD discipline and appends progress to `spec.md`.
|
|
56
|
+
3. **`check` (`/check`)**:
|
|
57
|
+
- **Purpose**: Senior QA review, multi-lane verification matrix (Typecheck, Lint, Test suites, manual proof), and records evidence into `spec.md`.
|
|
58
|
+
4. **`complete` (`/complete`)**:
|
|
59
|
+
- **Purpose**: Final safety pass, records Release Digest in `spec.md`, performs git merge, and closes the run without auto HTML generation.
|
|
44
60
|
|
|
45
|
-
|
|
46
|
-
- **Purpose**: Explore a request before delivery commitment without allocating a running ID.
|
|
47
|
-
- **Artifact**: `devflow/discoveries/{discovery-id}-{slug}/00-discover.md`
|
|
48
|
-
- **Gate**: Produces `Proceed`, `Defer`, or `Reject` decision.
|
|
61
|
+
---
|
|
49
62
|
|
|
50
|
-
2
|
|
51
|
-
- **Purpose**: Turn an approved discovery into one or more bounded delivery runs with stable scope and sequential Running IDs.
|
|
52
|
-
- **Artifact**: `devflow/runs/{running-id}-{slug}/10-define.md`
|
|
53
|
-
- **Gate**: Approved run map and explicit in-scope / out-of-scope boundaries.
|
|
63
|
+
## 🏗️ Track 2: Deep-Track (Architect Mode - 8 Steps)
|
|
54
64
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
65
|
+
Recommended for large architectural epics, database migrations, and multi-agent coordination:
|
|
66
|
+
|
|
67
|
+
```text
|
|
68
|
+
00-discover ──▶ 10-define ──▶ 20-spec ──▶ 30-plan ──▶ 40-implement ──▶ 50-verify ──▶ 60-report ──▶ 70-release
|
|
69
|
+
```
|
|
59
70
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
71
|
+
1. `00-discover`: Explore request before delivery commitment without allocating running ID (`00-discover.md`).
|
|
72
|
+
2. `10-define`: Turn approved discovery into bounded delivery run(s) with sequential Running IDs (`10-define.md`).
|
|
73
|
+
3. `20-spec`: Formalize markdown-first delivery contract & acceptance criteria (`20-spec.md`).
|
|
74
|
+
4. `30-plan`: Breakdown spec into executable tasks with test decisions (`30-plan.md` + checklists).
|
|
75
|
+
5. `40-implement`: Incremental task implementation behind review gates (`40-implement.md`).
|
|
76
|
+
6. `50-verify`: Senior QA review & multi-lane verification checks (`50-verify.md`).
|
|
77
|
+
7. `60-report`: Standardized markdown delivery digest (`60-report.md`).
|
|
78
|
+
8. `70-release`: Release packaging, release notes, git merge, and deployment (`70-release.md`).
|
|
64
79
|
|
|
65
|
-
|
|
66
|
-
- **Purpose**: Execute planned tasks incrementally one scoped unit at a time behind review gates.
|
|
67
|
-
- **Artifact**: `40-implement.md` (and updated checklists)
|
|
68
|
-
- **Gate**: Code changes tested, verification recorded, deviations documented.
|
|
80
|
+
---
|
|
69
81
|
|
|
70
|
-
|
|
71
|
-
- **Purpose**: Senior QA review and multi-lane validation check across functionality, regressions, and quality standards.
|
|
72
|
-
- **Artifact**: `50-verify.md` (optional `50-verify-impact.md`)
|
|
73
|
-
- **Gate**: Pass or return-to-implement decision with evidence.
|
|
82
|
+
## 🌐 Standalone HTML Reporting Policy
|
|
74
83
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
84
|
+
> [!IMPORTANT]
|
|
85
|
+
> **No Auto-Generated HTML**: Mainline flows (`/complete` and `60-report`) strictly output Markdown only.
|
|
86
|
+
> When an interactive web dashboard is desired for presentation or sharing, invoke the standalone companion command:
|
|
87
|
+
> `/report:html` (or `npm run report:html -- {RUNNING_ID}`).
|
|
79
88
|
|
|
80
|
-
|
|
81
|
-
- **Purpose**: Package verified work for delivery, git merge, pull request, changelog update, or deployment.
|
|
82
|
-
- **Artifact**: `70-release.md`
|
|
83
|
-
- **Gate**: Safe handoff, release notes, and deployment readiness.
|
|
89
|
+
---
|
|
84
90
|
|
|
85
|
-
|
|
91
|
+
## Public Companion Commands
|
|
86
92
|
|
|
87
93
|
- `devflow`: Flagship interactive guide, state inspector, and intent router.
|
|
94
|
+
- `idea` (`/idea`): Quick idea capture and AI feasibility enrichment into `devflow/ideas.md`.
|
|
95
|
+
- `report-html` (`/report:html`): Standalone interactive HTML report dashboard generator.
|
|
88
96
|
- `onboard`: Initial stack detection and baseline setup for fresh/scaffolded projects.
|
|
89
97
|
- `adopt`: Survey existing brownfield codebases and bootstrap DevFlow context.
|
|
90
98
|
- `doctor`: Read-only health check for context files, adapters, commands, and workflow drift.
|
|
@@ -92,49 +100,38 @@ Unused adapter families can be removed. Codex and Antigravity projects keep `.ag
|
|
|
92
100
|
- `rollback`: Safe feature/run reversal planner with dependency and commit risk analysis.
|
|
93
101
|
- `ci`: Automatic GitHub Actions workflow (`.github/workflows/verify.yml`) setup and alignment.
|
|
94
102
|
- `brief`: Read-only scope, dependency, and size pre-briefing before speccing a run.
|
|
95
|
-
- `autopilot`: Optional explicit mode for one bounded spec/plan/implement/verify/report pass
|
|
103
|
+
- `autopilot`: Optional explicit mode for one bounded spec/plan/implement/verify/report pass.
|
|
96
104
|
- `goal`: Route broad, open-ended goals before Discovery.
|
|
97
105
|
- `brainstorm`: Structured divergent & convergent ideation without creating running IDs.
|
|
98
106
|
- `research`: Conduct deep codebase or web research with source-backed citations.
|
|
99
107
|
- `debug`: Root cause investigation before or during implementation without editing code.
|
|
100
|
-
- `
|
|
101
|
-
- `
|
|
102
|
-
- `security-review`: High-severity vulnerability and security review.
|
|
103
|
-
- `wiki`: Knowledge base management and ingestion under `devflow/wiki/`.
|
|
108
|
+
- `overview`: Refresh `devflow/context/project-overview.md`.
|
|
109
|
+
- `wiki`: Knowledge base management under `devflow/wiki/`.
|
|
104
110
|
- `check-for-updates`: Verify or upgrade DevFlow setup.
|
|
105
111
|
- `help`: Routing and process assistance across DevFlow workflows.
|
|
106
112
|
|
|
107
|
-
|
|
113
|
+
---
|
|
108
114
|
|
|
109
|
-
|
|
115
|
+
## Invocation Reference
|
|
110
116
|
|
|
111
|
-
|
|
|
117
|
+
| Track / Category | Canonical Name | Claude / Antigravity (`/`) | OpenAI Codex (`$`) | Purpose / Action |
|
|
112
118
|
| :--- | :--- | :--- | :--- | :--- |
|
|
113
|
-
| **
|
|
114
|
-
| **
|
|
115
|
-
| **
|
|
116
|
-
| **
|
|
117
|
-
| **
|
|
118
|
-
| **
|
|
119
|
-
| **
|
|
120
|
-
| **
|
|
121
|
-
| **
|
|
122
|
-
| **
|
|
123
|
-
| **
|
|
124
|
-
| **
|
|
125
|
-
| **
|
|
126
|
-
| **
|
|
127
|
-
| **Stage 60** | `60-report` | `/60-report` | `$60-report` | Standalone markdown & HTML summary report |
|
|
128
|
-
| **Stage 70** | `70-release` | `/70-release` | `$70-release` | Package for delivery, git merge, PR, or deployment |
|
|
119
|
+
| **Fast: Spec** | `spec` | `/spec` / `/feature` / `/fix` | `$spec` / `$feature` / `$fix` | 4-step Fast-Track spec & living spec creation (supports `IDEA-xxx`) |
|
|
120
|
+
| **Fast: Implement** | `implement` | `/implement` | `$implement` | Fast-Track incremental execution with TDD |
|
|
121
|
+
| **Fast: Check** | `check` | `/check` | `$check` | Fast-Track QA review & multi-lane verification |
|
|
122
|
+
| **Fast: Complete** | `complete` | `/complete` | `$complete` | Fast-Track safety pass, release digest & git merge |
|
|
123
|
+
| **Idea Capture** | `idea` | `/idea` | `$idea` | Quick idea capture and AI feasibility enrichment |
|
|
124
|
+
| **HTML Report** | `report-html` | `/report:html` | `$report:html` | Standalone interactive HTML dashboard generator |
|
|
125
|
+
| **Deep: 00** | `00-discover` | `/00-discover` | `$00-discover` | Explore request and decide Proceed, Defer, or Reject |
|
|
126
|
+
| **Deep: 10** | `10-define` | `/10-define` | `$10-define` | Turn approved discovery into bounded delivery run(s) |
|
|
127
|
+
| **Deep: 20** | `20-spec` | `/20-spec` | `$20-spec` | Formal markdown delivery contract & acceptance criteria |
|
|
128
|
+
| **Deep: 30** | `30-plan` | `/30-plan` | `$30-plan` | Breakdown spec into executable tasks with test decisions |
|
|
129
|
+
| **Deep: 40** | `40-implement` | `/40-implement` | `$40-implement` | Implement tasks in small reviewable increments |
|
|
130
|
+
| **Deep: 50** | `50-verify` | `/50-verify` | `$50-verify` | Senior QA review & multi-lane verification checks |
|
|
131
|
+
| **Deep: 60** | `60-report` | `/60-report` | `$60-report` | Standalone markdown summary report |
|
|
132
|
+
| **Deep: 70** | `70-release` | `/70-release` | `$70-release` | Package for delivery, git merge, PR, or deployment |
|
|
129
133
|
| **Router** | `devflow` | `/devflow` | `$devflow` | Interactive guide, state inspector, and intent router |
|
|
130
134
|
|
|
131
|
-
## Mainline Rules
|
|
132
|
-
|
|
133
|
-
1. Numbered workflows exist only for the linear mainline.
|
|
134
|
-
2. Mainline numbers must move from lower to higher with no backward jump.
|
|
135
|
-
3. If a command is not a true mainline state, do not give it a number.
|
|
136
|
-
4. Companion commands may be suggested by a mainline workflow but do not replace that workflow.
|
|
137
|
-
|
|
138
135
|
## Commands
|
|
139
136
|
|
|
140
137
|
- Dev Server: `npm run dev`
|
|
@@ -32,3 +32,4 @@
|
|
|
32
32
|
- Run `/20-Spec` and `/30-Plan` to establish formal delivery specifications and execution plans.
|
|
33
33
|
- Run `/40-Implement` for step-by-step code implementation with evidence.
|
|
34
34
|
- Run `/50-Verify`, `/60-Report`, and `/70-Release` for quality verification, reporting, and release packaging.
|
|
35
|
+
- Use **Fast-Track / Quick-Fix mode** for minor hotfixes to skip heavy ceremony while keeping test evidence.
|
|
@@ -1,27 +1,40 @@
|
|
|
1
|
-
# Coding Standards
|
|
1
|
+
# Coding Standards & Guidelines
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
> Run `/onboard` (or `/adopt` for existing codebases) to tune these standards to your specific stack.
|
|
3
|
+
General engineering standards for code, tests, and documentation in Nexus-DevFlow.
|
|
5
4
|
|
|
6
|
-
##
|
|
5
|
+
## 1. Code Quality & Architecture
|
|
7
6
|
|
|
8
|
-
- Write
|
|
9
|
-
-
|
|
10
|
-
-
|
|
7
|
+
- Write clear, self-documenting code with single-responsibility functions.
|
|
8
|
+
- Avoid unnecessary complexity (prefer simple solutions over indirect abstractions).
|
|
9
|
+
- Maintain type safety and static validation across module boundaries.
|
|
10
|
+
- Treat `project-overview.md` as the single source of truth for concrete data models and entity definitions.
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## 2. Testing & Empirical Proof Standards
|
|
13
13
|
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
14
|
+
- **Unit Test Mandate**: Any logic modification or bug fix must be accompanied by new or updated unit tests.
|
|
15
|
+
- **Empirical Proof Contract**: Never claim "passed", "verified", or "working" without citing exact command outputs, test run reports, route responses, logs, or screenshots.
|
|
16
|
+
- **Manual Try Guide**: Every delivery run must provide a human-testable Try Guide ("Where to go", "What to click", "What to expect") for manual validation.
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## 3. Findings Ledger & Quality Gates (`findings.md`)
|
|
19
19
|
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
20
|
+
- All audit, security, and verification issues must be tracked in `devflow/context/findings.md`.
|
|
21
|
+
- **Finding State Machine**:
|
|
22
|
+
- `open`: Confirmed defect not yet repaired.
|
|
23
|
+
- `fixed`: Repaired in code, pending verification.
|
|
24
|
+
- `closed`: Verified in `50-verify` as completely resolved without regressions.
|
|
25
|
+
- `accepted`: Waived with recorded user rationale.
|
|
26
|
+
- `invalid`: Proven non-issue with concrete evidence.
|
|
27
|
+
- **P0/P1 Blockers**: P0 and P1 findings in `open` or `fixed` status block `70-release` unconditionally. `fixed` status must be promoted to `closed` via `50-verify` re-examination.
|
|
23
28
|
|
|
24
|
-
##
|
|
29
|
+
## 4. Git Workflow & Release Safety
|
|
30
|
+
|
|
31
|
+
- Commit messages follow conventional/imperative format (e.g., `feat(RUN-007): ...`).
|
|
32
|
+
- Feature branches follow `feature/{slug}-{running-id}` or `fix/{slug}-{running-id}`.
|
|
33
|
+
- **2-Stage Release Approvals**: Explicit consent to merge into `main` is strictly separate from consent to `git push` to remote repositories or deploy to production.
|
|
25
34
|
|
|
26
|
-
|
|
27
|
-
|
|
35
|
+
## 5. Fast-Track & Quick-Fix Guidelines (Lean Mode)
|
|
36
|
+
|
|
37
|
+
- For trivial bug fixes, typo corrections, or single-file non-architectural changes, developers and agents may use the **Quick-Fix Fast-Track**:
|
|
38
|
+
- Consolidate Discovery, Define, and Spec into an inline fix brief (`devflow/runs/{fix-id}/fix-brief.md`).
|
|
39
|
+
- Jump directly to `40-implement` (with reproduction unit test) ➔ `50-verify` ➔ `70-release`.
|
|
40
|
+
- Avoid creating heavy redundant documentation for changes under 20 lines of code while preserving Empirical Proof and Unit Test requirements.
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
- **Active Discovery ID**: None
|
|
4
4
|
- **Active Running ID**: None
|
|
5
|
-
- **Current Stage**:
|
|
6
|
-
- **Last Completed Run**:
|
|
7
|
-
- **Last Updated**: -
|
|
5
|
+
- **Current Stage**: Ready for new work (Fast-Track: `/spec`, `/feature`, `/fix`, or Deep-Track: `00-discover`, Idea: `/idea`)
|
|
6
|
+
- **Last Completed Run**: RUN-016-idea-capture-inbox-and-status-integration (2026-08-20)
|
|
7
|
+
- **Last Updated**: 2026-08-20
|
|
@@ -1,9 +1,13 @@
|
|
|
1
|
-
# Findings Ledger
|
|
1
|
+
# Audit Findings Ledger
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
> Resolved findings are tracked with durable IDs.
|
|
3
|
+
Summary of audit findings, quality checks, security bugs, and debt tracked across DevFlow runs.
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
- **Total Tracked**: 0
|
|
5
|
+
## Open Findings
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
| ID | Severity | Category | Title | Discovered Run | Status |
|
|
8
|
+
| :- | :--- | :--- | :--- | :--- | :--- |
|
|
9
|
+
|
|
10
|
+
## Resolved Findings
|
|
11
|
+
|
|
12
|
+
| ID | Severity | Category | Title | Resolved Run | Date |
|
|
13
|
+
| :- | :--- | :--- | :--- | :--- | :--- |
|