@jakkrichm/create-nexus-devflow 2.0.15 → 2.0.18
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 +15 -1
- package/dist/bin/create-nexus-devflow.js +125 -9
- package/dist/bin/create-nexus-devflow.js.map +1 -1
- package/dist/lib/current-work.d.ts +29 -0
- package/dist/lib/current-work.js +235 -0
- package/dist/lib/current-work.js.map +1 -0
- package/dist/lib/findings.d.ts +26 -0
- package/dist/lib/findings.js +110 -0
- package/dist/lib/findings.js.map +1 -0
- package/dist/lib/git-status.d.ts +13 -0
- package/dist/lib/git-status.js +98 -0
- package/dist/lib/git-status.js.map +1 -0
- package/dist/lib/project-metadata.d.ts +22 -0
- package/dist/lib/project-metadata.js +84 -0
- package/dist/lib/project-metadata.js.map +1 -0
- package/dist/lib/project-root.d.ts +3 -0
- package/dist/lib/project-root.js +76 -0
- package/dist/lib/project-root.js.map +1 -0
- package/dist/lib/status.d.ts +62 -0
- package/dist/lib/status.js +273 -0
- package/dist/lib/status.js.map +1 -0
- package/dist/lib/uninstall.d.ts +20 -0
- package/dist/lib/uninstall.js +129 -0
- package/dist/lib/uninstall.js.map +1 -0
- package/dist/scripts/prepare-template.js +120 -10
- package/dist/scripts/prepare-template.js.map +1 -1
- package/package.json +4 -3
- package/template/.agents/skills/00-discover/SKILL.md +2 -2
- package/template/.agents/skills/10-define/SKILL.md +24 -140
- package/template/.agents/skills/20-spec/SKILL.md +2 -2
- package/template/.agents/skills/30-plan/SKILL.md +2 -2
- package/template/.agents/skills/50-verify/SKILL.md +2 -2
- package/template/.agents/skills/60-report/SKILL.md +1 -1
- package/template/.agents/skills/70-release/SKILL.md +19 -143
- package/template/.agents/skills/check/SKILL.md +10 -10
- package/template/.agents/skills/ci/SKILL.md +1 -1
- package/template/.agents/skills/complete/SKILL.md +49 -28
- package/template/.agents/skills/deploy/SKILL.md +1 -1
- package/template/.agents/skills/devflow/SKILL.md +5 -5
- package/template/.agents/skills/feature/SKILL.md +25 -20
- package/template/.agents/skills/fix/SKILL.md +25 -19
- package/template/.agents/skills/implement/SKILL.md +10 -10
- package/template/.agents/skills/insight/SKILL.md +1 -1
- package/template/.agents/skills/overview/SKILL.md +3 -3
- package/template/.agents/skills/report-html/SKILL.md +3 -3
- package/template/.agents/skills/security-review/SKILL.md +1 -1
- package/template/.agents/skills/spec/SKILL.md +7 -6
- package/template/.agents/skills/spec-driven-development/SKILL.md +2 -2
- package/template/.agents/skills/test/SKILL.md +1 -1
- package/template/.claude/skills/00-discover/SKILL.md +2 -2
- package/template/.claude/skills/10-define/SKILL.md +24 -140
- package/template/.claude/skills/20-spec/SKILL.md +2 -2
- package/template/.claude/skills/30-plan/SKILL.md +2 -2
- package/template/.claude/skills/50-verify/SKILL.md +2 -2
- package/template/.claude/skills/60-report/SKILL.md +1 -1
- package/template/.claude/skills/70-release/SKILL.md +19 -143
- package/template/.claude/skills/check/SKILL.md +10 -10
- package/template/.claude/skills/ci/SKILL.md +1 -1
- package/template/.claude/skills/complete/SKILL.md +49 -28
- package/template/.claude/skills/deploy/SKILL.md +1 -1
- package/template/.claude/skills/devflow/SKILL.md +5 -5
- package/template/.claude/skills/feature/SKILL.md +25 -20
- package/template/.claude/skills/fix/SKILL.md +25 -19
- package/template/.claude/skills/implement/SKILL.md +10 -10
- package/template/.claude/skills/insight/SKILL.md +1 -1
- package/template/.claude/skills/overview/SKILL.md +3 -3
- package/template/.claude/skills/report-html/SKILL.md +3 -3
- package/template/.claude/skills/security-review/SKILL.md +1 -1
- package/template/.claude/skills/spec/SKILL.md +7 -6
- package/template/.claude/skills/spec-driven-development/SKILL.md +2 -2
- package/template/.claude/skills/test/SKILL.md +1 -1
- package/template/AGENTS.md +15 -59
- package/template/devflow/context/ai-interaction.md +110 -23
- package/template/devflow/context/coding-standards.md +123 -32
- package/template/devflow/context/current-feature.md +3 -0
- package/template/devflow/context/current-stage.md +6 -6
- package/template/devflow/context/findings.md +10 -10
- package/template/devflow/context/project-overview.md +18 -32
- package/template/devflow/history/HISTORY.md +10 -24
- package/template/devflow/ideas.md +9 -5
- package/template/devflow/reference/running-id-contract.md +39 -39
- package/template/devflow/runs/.gitkeep +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: implement
|
|
3
|
-
description: "[Devflow] Fast-Track Implement stage in DevFlow (Blueprint Mode) - execute checklist tasks incrementally with TDD and update
|
|
3
|
+
description: "[Devflow] Fast-Track Implement stage in DevFlow (Blueprint Mode) - execute checklist tasks incrementally with TDD and update current-feature.md in context."
|
|
4
4
|
argument-hint: "{running-id or workspace path}"
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -8,18 +8,18 @@ argument-hint: "{running-id or workspace path}"
|
|
|
8
8
|
|
|
9
9
|
$ARGUMENTS
|
|
10
10
|
|
|
11
|
-
Incremental code execution stage in Fast-Track. Reads the Single Living Spec (`
|
|
11
|
+
Incremental code execution stage in Fast-Track. Reads the Single Living Spec (`devflow/context/current-feature.md`), executes checklist tasks, implements tests (TDD), and updates the implementation record.
|
|
12
12
|
|
|
13
13
|
## Invocations & Aliases
|
|
14
14
|
|
|
15
15
|
- `/implement`: Run implementation on current active run
|
|
16
|
-
- `/implement {
|
|
16
|
+
- `/implement {id}`: Run implementation on specified ID
|
|
17
17
|
- `$implement`: Codex CLI invocation
|
|
18
18
|
|
|
19
19
|
## Fast-Track Mainline Workflow
|
|
20
20
|
|
|
21
21
|
```text
|
|
22
|
-
/
|
|
22
|
+
/feature (หรือ /fix) ──▶ /implement ──▶ /check ──▶ /complete
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
## Behavior & Contract
|
|
@@ -27,8 +27,8 @@ Incremental code execution stage in Fast-Track. Reads the Single Living Spec (`s
|
|
|
27
27
|
When invoked:
|
|
28
28
|
|
|
29
29
|
### 1. Load Active Context
|
|
30
|
-
1. Identify active Running ID from `devflow/context/current-stage.md` or
|
|
31
|
-
2. Read `devflow/
|
|
30
|
+
1. Identify active Running ID from `devflow/context/current-stage.md` or `devflow/context/current-feature.md`.
|
|
31
|
+
2. Read `devflow/context/current-feature.md`.
|
|
32
32
|
3. Locate `## 2. Plan & Test Strategy` and `## 3. Implementation Checklist`.
|
|
33
33
|
|
|
34
34
|
### 2. Incremental Execution with TDD
|
|
@@ -37,10 +37,10 @@ When invoked:
|
|
|
37
37
|
- **TDD (Red-Green-Refactor)**: When `Test Decision: Required`, create or update unit tests first.
|
|
38
38
|
- Implement the minimal, clean code change satisfying the task.
|
|
39
39
|
- Run localized verification (e.g. `npm test`, linter).
|
|
40
|
-
- Mark the item as `- [x]` in `
|
|
40
|
+
- Mark the item as `- [x]` in `current-feature.md`.
|
|
41
41
|
|
|
42
|
-
### 3. Update Living Spec (`
|
|
43
|
-
Append or update `## 4. Implementation Record` in `
|
|
42
|
+
### 3. Update Living Spec (`current-feature.md`)
|
|
43
|
+
Append or update `## 4. Implementation Record` in `devflow/context/current-feature.md` with:
|
|
44
44
|
- Summary of completed tasks and modified files
|
|
45
45
|
- Key architectural observations or notes
|
|
46
46
|
- Status of checklist items
|
|
@@ -61,4 +61,4 @@ Update `devflow/context/current-stage.md`:
|
|
|
61
61
|
Report to the user:
|
|
62
62
|
- Completed checklist items and modified files
|
|
63
63
|
- Local verification results
|
|
64
|
-
- **Next Command**: `/check` (or `/check {
|
|
64
|
+
- **Next Command**: `/check` (or `/check {ID}`)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: insight
|
|
3
|
-
description: "[Devflow] Extract reusable lessons,
|
|
3
|
+
description: "[Devflow] Extract reusable lessons, patterns, file insights, and post-mortem learning from completed work."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Insight Extraction & Post-Mortem Learning
|
|
@@ -13,7 +13,7 @@ codebase + devflow/history/HISTORY.md -> [overview] -> devflow/context/proje
|
|
|
13
13
|
synthesize)
|
|
14
14
|
```
|
|
15
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/
|
|
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/history/`) to build or refresh `devflow/context/project-overview.md`.
|
|
17
17
|
|
|
18
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
19
|
|
|
@@ -26,7 +26,7 @@ overview
|
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
Use this when:
|
|
29
|
-
- Multiple delivery runs (`
|
|
29
|
+
- Multiple delivery runs (`xxx-slug`) have shipped and `project-overview.md` needs to reflect newly added capabilities.
|
|
30
30
|
- New database schemas, ORM models, or API boundaries were introduced.
|
|
31
31
|
- Major dependencies or architectural patterns were added or modified.
|
|
32
32
|
- After completing `70-release` to keep project context perfectly aligned.
|
|
@@ -59,7 +59,7 @@ Inspect the actual codebase to establish hard facts:
|
|
|
59
59
|
Inspect DevFlow history records:
|
|
60
60
|
|
|
61
61
|
1. Read `devflow/history/HISTORY.md` for completed and released milestones.
|
|
62
|
-
2. Scan completed delivery runs in `devflow/
|
|
62
|
+
2. Scan completed delivery runs in `devflow/history/features/`, `devflow/history/fixes/`, and `devflow/history/rollbacks/` to extract shipped user-visible capabilities and core system features.
|
|
63
63
|
|
|
64
64
|
---
|
|
65
65
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: report-html
|
|
3
|
-
description: "[Devflow] Standalone HTML Report Generator - render an interactive standalone HTML dashboard from
|
|
3
|
+
description: "[Devflow] Standalone HTML Report Generator - render an interactive standalone HTML dashboard from current-feature.md or 60-report.md on demand."
|
|
4
4
|
argument-hint: "{running-id or workspace path}"
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -8,7 +8,7 @@ argument-hint: "{running-id or workspace path}"
|
|
|
8
8
|
|
|
9
9
|
$ARGUMENTS
|
|
10
10
|
|
|
11
|
-
Standalone companion command to generate an interactive, self-contained HTML report dashboard on demand from either a Fast-Track `
|
|
11
|
+
Standalone companion command to generate an interactive, self-contained HTML report dashboard on demand from either a Fast-Track `current-feature.md` or a Deep-Track `60-report.md`.
|
|
12
12
|
|
|
13
13
|
> [!NOTE]
|
|
14
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.
|
|
@@ -27,7 +27,7 @@ When invoked:
|
|
|
27
27
|
### 1. Identify Target Run
|
|
28
28
|
1. Locate target run directory in `devflow/runs/{running-id}` from argument or `devflow/context/current-stage.md`.
|
|
29
29
|
2. Check for either:
|
|
30
|
-
- Fast-Track Living Spec: `devflow/runs/{RUNNING_ID}/
|
|
30
|
+
- Fast-Track Living Spec: `devflow/runs/{RUNNING_ID}/current-feature.md` (or `spec.md` / `blueprint.md`)
|
|
31
31
|
- Deep-Track Report Digest: `devflow/runs/{RUNNING_ID}/60-report.md`
|
|
32
32
|
|
|
33
33
|
### 2. Render Interactive HTML Dashboard
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: security-review
|
|
3
|
-
description: "[Devflow]
|
|
3
|
+
description: "[Devflow] High-severity security code review and vulnerability audit for folders, projects, files, or diffs."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Security Review, Hardening & Vulnerability Audit
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: spec
|
|
3
|
-
description: "[Devflow] Fast-Track Spec router in DevFlow (Blueprint Mode) - aliases and routes to /feature or /fix to create the
|
|
3
|
+
description: "[Devflow] Fast-Track Spec router in DevFlow (Blueprint Mode) - aliases and routes to /feature or /fix to create the living current-feature.md contract in context."
|
|
4
4
|
argument-hint: "{feature title, bug description, IDEA-xxx, or running-id}"
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -8,7 +8,7 @@ argument-hint: "{feature title, bug description, IDEA-xxx, or running-id}"
|
|
|
8
8
|
|
|
9
9
|
$ARGUMENTS
|
|
10
10
|
|
|
11
|
-
Unified Fast-Track entry point that routes to `/feature` or `/fix` to create and maintain the **Single Living Spec (`
|
|
11
|
+
Unified Fast-Track entry point that routes to `/feature` or `/fix` to create and maintain the **Single Living Spec (`devflow/context/current-feature.md`)**.
|
|
12
12
|
|
|
13
13
|
> [!TIP]
|
|
14
14
|
> **Preferred Commands**:
|
|
@@ -32,7 +32,8 @@ Unified Fast-Track entry point that routes to `/feature` or `/fix` to create and
|
|
|
32
32
|
|
|
33
33
|
When invoked:
|
|
34
34
|
|
|
35
|
-
1.
|
|
36
|
-
2.
|
|
37
|
-
3.
|
|
38
|
-
4.
|
|
35
|
+
1. Checks Single Active Run Guardrail: rejects if an uncompleted active run already exists in `devflow/context/current-stage.md` or `devflow/context/current-feature.md`.
|
|
36
|
+
2. If the input describes a bug or hotfix, routes to `/fix` behavior.
|
|
37
|
+
3. Otherwise, routes to `/feature` behavior.
|
|
38
|
+
4. Allocates sequential ID without prefix (`xxx-slug`), generates `devflow/context/current-feature.md` in **Thai (`th`)**.
|
|
39
|
+
5. Updates `devflow/context/current-stage.md` and reports next step: `/implement`.
|
|
@@ -83,8 +83,8 @@ Don't silently fill in ambiguous requirements. The spec's entire purpose is to s
|
|
|
83
83
|
|
|
84
84
|
Every specification must stand on its own in markdown under `devflow/runs/{ID}-*/`:
|
|
85
85
|
|
|
86
|
-
1. **`
|
|
87
|
-
2. **`spec.md`**:
|
|
86
|
+
1. **`current-feature.md`**: Fast-Track Single Living Spec delivery contract.
|
|
87
|
+
2. **`20-spec.md`**: Deep-Track formal specification delivery contract.
|
|
88
88
|
|
|
89
89
|
**Spec template:**
|
|
90
90
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: test
|
|
3
|
-
description: "[Devflow] Test
|
|
3
|
+
description: "[Devflow] Test execution, missing test generation, and coverage analysis across unit, integration, and smoke test suites."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Test-Driven Development, Generation & Execution
|
package/template/AGENTS.md
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
|
-
# Nexus-DevFlow 2.0 (
|
|
1
|
+
# Nexus-DevFlow 2.0 (The 3-Pillars & Dual-Track 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 workflow layer supporting **Dual-Track Delivery**:
|
|
8
|
-
1.
|
|
9
|
-
2.
|
|
7
|
+
This project uses **Nexus-DevFlow**, an agentic workflow layer supporting **The 3-Pillars Workspace Architecture & Dual-Track Delivery**:
|
|
8
|
+
1. **🔮 Future (Backlog)**: `devflow/ideas.md` — Centralized Idea Inbox with AI scoring.
|
|
9
|
+
2. **⚡ Present (Active Context)**: `devflow/context/` — Living Source of Truth & Active Work (`current-feature.md` for Fast-Track, `current-run/` for Deep-Track).
|
|
10
|
+
3. **📦 Past (History Archive)**: `devflow/history/` — Categorized delivery archives (`features/`, `fixes/`, `rollbacks/`, and `HISTORY.md`).
|
|
10
11
|
|
|
11
12
|
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.
|
|
12
13
|
|
|
@@ -35,8 +36,8 @@ Unused adapter families can be removed. Codex and Antigravity projects keep `.ag
|
|
|
35
36
|
- **Dollar Prefix (`$`)**: For OpenAI Codex CLI or skill-invocation tools, e.g., `$feature`, `$fix`, `$40-execute`, `$devflow`.
|
|
36
37
|
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.
|
|
37
38
|
3. **Google Antigravity & Claude Code**: Native skill engines automatically discover and surface `.agents/skills/` and `.claude/skills/`.
|
|
38
|
-
4. **State-Aware Inspection**: When unsure what to do next, invoke `devflow` to automatically inspect `devflow/context/current-stage.md` and active
|
|
39
|
-
5. **Default Artifact & Communication Language (Thai)**: All generated markdown stage artifacts (`
|
|
39
|
+
4. **State-Aware Inspection**: When unsure what to do next, invoke `devflow` to automatically inspect `devflow/context/current-stage.md` and active context in `devflow/context/`.
|
|
40
|
+
5. **Default Artifact & Communication Language (Thai)**: All generated markdown stage artifacts (`current-feature.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
|
|
|
41
42
|
---
|
|
42
43
|
|
|
@@ -49,14 +50,14 @@ Recommended for 85% of daily work (features, bug fixes, UI improvements, iterati
|
|
|
49
50
|
```
|
|
50
51
|
|
|
51
52
|
1. **`feature` / `fix` (`/feature`, `/fix`, `/spec`)**:
|
|
52
|
-
- **Purpose**: Combines Discover, Define, Spec, and Plan into one unified step.
|
|
53
|
-
- **Artifact**: `devflow/
|
|
53
|
+
- **Purpose**: Combines Discover, Define, Spec, and Plan into one unified step. Checks Single Active Run Guardrail, allocates sequential ID (`xxx-slug`), and creates the **Single Living Spec (`devflow/context/current-feature.md`)**.
|
|
54
|
+
- **Artifact**: `devflow/context/current-feature.md`
|
|
54
55
|
2. **`implement` (`/implement`)**:
|
|
55
|
-
- **Purpose**: Incrementally executes checklist tasks with TDD discipline and appends progress to `
|
|
56
|
+
- **Purpose**: Incrementally executes checklist tasks with TDD discipline and appends progress to `devflow/context/current-feature.md`.
|
|
56
57
|
3. **`check` (`/check`)**:
|
|
57
|
-
- **Purpose**: Senior QA review, multi-lane verification matrix (Typecheck, Lint, Test suites, manual proof), and records evidence into `
|
|
58
|
+
- **Purpose**: Senior QA review, multi-lane verification matrix (Typecheck, Lint, Test suites, manual proof), and records evidence into `devflow/context/current-feature.md`.
|
|
58
59
|
4. **`complete` (`/complete`)**:
|
|
59
|
-
- **Purpose**: Final safety pass, records Release Digest
|
|
60
|
+
- **Purpose**: Final safety pass, records Release Digest, automatically archives to `devflow/history/{features|fixes|rollbacks}/{xxx-slug}.md`, resets the stub, performs git merge, and closes the run without auto HTML generation.
|
|
60
61
|
|
|
61
62
|
---
|
|
62
63
|
|
|
@@ -69,13 +70,13 @@ Recommended for large architectural epics, database migrations, and multi-agent
|
|
|
69
70
|
```
|
|
70
71
|
|
|
71
72
|
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
|
|
73
|
+
2. `10-define`: Turn approved discovery into bounded delivery run in `devflow/context/current-run/10-define.md`.
|
|
73
74
|
3. `20-spec`: Formalize markdown-first delivery contract & acceptance criteria (`20-spec.md`).
|
|
74
75
|
4. `30-plan`: Breakdown spec into executable tasks with test decisions (`30-plan.md` + checklists).
|
|
75
76
|
5. `40-execute`: Incremental task execution behind review gates (`40-execute.md`).
|
|
76
77
|
6. `50-verify`: Senior QA review & multi-lane verification checks (`50-verify.md`).
|
|
77
78
|
7. `60-report`: Standardized markdown delivery digest (`60-report.md`).
|
|
78
|
-
8. `70-release`: Release packaging,
|
|
79
|
+
8. `70-release`: Release packaging, git merge, archives `devflow/context/current-run/` ➔ `devflow/history/{category}/{xxx-slug}/`, and closes run.
|
|
79
80
|
|
|
80
81
|
---
|
|
81
82
|
|
|
@@ -84,55 +85,10 @@ Recommended for large architectural epics, database migrations, and multi-agent
|
|
|
84
85
|
> [!IMPORTANT]
|
|
85
86
|
> **No Auto-Generated HTML**: Mainline flows (`/complete` and `60-report`) strictly output Markdown only.
|
|
86
87
|
> When an interactive web dashboard is desired for presentation or sharing, invoke the standalone companion command:
|
|
87
|
-
> `/report:html` (or `npm run report:html -- {
|
|
88
|
+
> `/report:html` (or `npm run report:html -- {ID}`).
|
|
88
89
|
|
|
89
90
|
---
|
|
90
91
|
|
|
91
|
-
## Public Companion Commands
|
|
92
|
-
|
|
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.
|
|
96
|
-
- `onboard`: Initial stack detection and baseline setup for fresh/scaffolded projects.
|
|
97
|
-
- `adopt`: Survey existing brownfield codebases and bootstrap DevFlow context.
|
|
98
|
-
- `doctor`: Read-only health check for context files, adapters, commands, and workflow drift.
|
|
99
|
-
- `try`: Step-by-step human manual QA review guide (where to go, what to click, what to expect).
|
|
100
|
-
- `rollback`: Safe feature/run reversal planner with dependency and commit risk analysis.
|
|
101
|
-
- `ci`: Automatic GitHub Actions workflow (`.github/workflows/verify.yml`) setup and alignment.
|
|
102
|
-
- `brief`: Read-only scope, dependency, and size pre-briefing before speccing a run.
|
|
103
|
-
- `autopilot`: Optional explicit mode for one bounded spec/plan/implement/verify/report pass.
|
|
104
|
-
- `goal`: Route broad, open-ended goals before Discovery.
|
|
105
|
-
- `brainstorm`: Structured divergent & convergent ideation without creating running IDs.
|
|
106
|
-
- `research`: Conduct deep codebase or web research with source-backed citations.
|
|
107
|
-
- `debug`: Root cause investigation before or during implementation without editing code.
|
|
108
|
-
- `overview`: Refresh `devflow/context/project-overview.md`.
|
|
109
|
-
- `wiki`: Knowledge base management under `devflow/wiki/`.
|
|
110
|
-
- `check-for-updates`: Verify or upgrade DevFlow setup.
|
|
111
|
-
- `help`: Routing and process assistance across DevFlow workflows.
|
|
112
|
-
|
|
113
|
-
---
|
|
114
|
-
|
|
115
|
-
## Invocation Reference
|
|
116
|
-
|
|
117
|
-
| Track / Category | Canonical Name | Claude / Antigravity (`/`) | OpenAI Codex (`$`) | Purpose / Action |
|
|
118
|
-
| :--- | :--- | :--- | :--- | :--- |
|
|
119
|
-
| **Fast: Feature** | `feature` | `/feature` | `$feature` | 4-step Fast-Track spec & living spec creation for new features (supports `IDEA-xxx`) |
|
|
120
|
-
| **Fast: Fix** | `fix` | `/fix` | `$fix` | 4-step Fast-Track spec & living spec creation for bug fixes (supports `IDEA-xxx`) |
|
|
121
|
-
| **Fast: Implement** | `implement` | `/implement` | `$implement` | Fast-Track incremental execution with TDD |
|
|
122
|
-
| **Fast: Check** | `check` | `/check` | `$check` | Fast-Track QA review & multi-lane verification |
|
|
123
|
-
| **Fast: Complete** | `complete` | `/complete` | `$complete` | Fast-Track safety pass, release digest & git merge |
|
|
124
|
-
| **Idea Capture** | `idea` | `/idea` | `$idea` | Quick idea capture and AI feasibility enrichment |
|
|
125
|
-
| **HTML Report** | `report-html` | `/report:html` | `$report:html` | Standalone interactive HTML dashboard generator |
|
|
126
|
-
| **Deep: 00** | `00-discover` | `/00-discover` | `$00-discover` | Explore request and decide Proceed, Defer, or Reject |
|
|
127
|
-
| **Deep: 10** | `10-define` | `/10-define` | `$10-define` | Turn approved discovery into bounded delivery run(s) |
|
|
128
|
-
| **Deep: 20** | `20-spec` | `/20-spec` | `$20-spec` | Formal markdown delivery contract & acceptance criteria |
|
|
129
|
-
| **Deep: 30** | `30-plan` | `/30-plan` | `$30-plan` | Breakdown spec into executable tasks with test decisions |
|
|
130
|
-
| **Deep: 40** | `40-execute` | `/40-execute` | `$40-execute` | Execute planned tasks in small reviewable increments (`40-execute.md`) |
|
|
131
|
-
| **Deep: 50** | `50-verify` | `/50-verify` | `$50-verify` | Senior QA review & multi-lane verification checks |
|
|
132
|
-
| **Deep: 60** | `60-report` | `/60-report` | `$60-report` | Standalone markdown summary report |
|
|
133
|
-
| **Deep: 70** | `70-release` | `/70-release` | `$70-release` | Package for delivery, git merge, PR, or deployment |
|
|
134
|
-
| **Router** | `devflow` | `/devflow` | `$devflow` | Interactive guide, state inspector, and intent router |
|
|
135
|
-
|
|
136
92
|
## Commands
|
|
137
93
|
|
|
138
94
|
- Dev Server: `npm run dev`
|
|
@@ -1,35 +1,122 @@
|
|
|
1
|
-
# AI Interaction Guidelines for DevFlow
|
|
1
|
+
# AI Interaction Guidelines for Nexus-DevFlow
|
|
2
2
|
|
|
3
|
-
> **DevFlow is an agentic workflow layer**, overlaying on top of scaffolded or existing codebases.
|
|
3
|
+
> **Nexus-DevFlow is an agentic workflow layer**, overlaying on top of scaffolded or existing codebases. Never run a framework scaffolder inside an initialized DevFlow directory.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
---
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- Explain technical trade-offs and non-obvious design decisions briefly.
|
|
9
|
-
- Always confirm before performing major refactors or destructive operations.
|
|
10
|
-
- Maintain markdown-first evidence for all stage activities.
|
|
7
|
+
## 1. Communication & Principles
|
|
11
8
|
|
|
12
|
-
|
|
9
|
+
- **Be Concise and Direct**: State conclusions, status, and findings first; provide supporting context afterward.
|
|
10
|
+
- **Explain Non-Obvious Decisions Briefly**: Highlight architectural trade-offs, edge-case rationale, or safety considerations in 1–2 sentences.
|
|
11
|
+
- **Ask Before Destructive or Architectural Changes**: Always obtain explicit confirmation before deleting files, executing major refactors, or altering public interfaces.
|
|
12
|
+
- **Don't Add Unplanned Scope**: Stick strictly to the Acceptance Criteria defined in the spec. Avoid adding "nice-to-have" features that were not requested.
|
|
13
|
+
- **Preserve Existing Codebase Patterns**: Respect existing file structure, typing patterns, naming conventions, and deep module boundaries.
|
|
13
14
|
|
|
14
|
-
|
|
15
|
-
- Use exact schema headings when validators check for specific contract sections.
|
|
15
|
+
---
|
|
16
16
|
|
|
17
|
-
## Output Formatting
|
|
17
|
+
## 2. Output Formatting
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
- Use lists for steps, options, and findings.
|
|
21
|
-
- Use tables for comparative matrices or stage summaries.
|
|
22
|
-
- Use backticks for paths, filenames, identifiers, and CLI commands.
|
|
19
|
+
Format every response for fast scanning and readability:
|
|
23
20
|
|
|
24
|
-
|
|
21
|
+
- **Real Markdown, Not Prose Walls**: Use bold labels, concise bullet points, and blank lines between blocks.
|
|
22
|
+
- **Enumerations Are Lists**: Numbered or bulleted lists for sequential steps or findings, never inline runs crammed into paragraphs.
|
|
23
|
+
- **Tables for Comparative Matrices**: Use markdown tables when comparing status, options, test results, or trade-offs.
|
|
24
|
+
- **Backticks for Code References**: Wrap file paths, variable names, functions, CLI flags, and commands in backticks (e.g. `current-feature.md`, `npm run check`).
|
|
25
|
+
- **Clickable File Links**: Use GitHub-style markdown links with `file://` scheme (e.g. `[current-feature.md](file:///d:/path/to/current-feature.md)`).
|
|
26
|
+
- **Lead With the Result**: State pass/fail status or completed action before presenting logs.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 3. Dual-Track Workflow Lifecycle (The 3-Pillars Model)
|
|
25
31
|
|
|
26
32
|
```text
|
|
27
|
-
/
|
|
33
|
+
devflow/
|
|
34
|
+
├── 🔮 ideas.md # [Future] Idea Inbox
|
|
35
|
+
├── ⚡ context/ # [Present] Living Spec (current-feature.md) & Active State
|
|
36
|
+
└── 📦 history/ # [Past] features/, fixes/, rollbacks/, and HISTORY.md
|
|
28
37
|
```
|
|
29
38
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
39
|
+
### 🏎️ Track 1: Fast-Track (Blueprint Mode — 4 Steps)
|
|
40
|
+
*Recommended for 85% of daily engineering work (features, bug fixes, UI improvements, iterative refactoring).*
|
|
41
|
+
|
|
42
|
+
The entire lifecycle is driven by the **Single Living Spec (`devflow/context/current-feature.md`)**:
|
|
43
|
+
|
|
44
|
+
1. **Spec (`/feature` or `/fix`)**:
|
|
45
|
+
- Checks **Single Active Run Guardrail** (rejects if an uncompleted task is still active).
|
|
46
|
+
- Analyzes request (or consumes `IDEA-xxx` from `devflow/ideas.md`).
|
|
47
|
+
- Allocates sequential ID without prefix (e.g. `022-{slug}`) and creates branch `feature/{xxx-slug}` or `fix/{xxx-slug}`.
|
|
48
|
+
- Generates `devflow/context/current-feature.md` containing **Section 1 (Scope & AC)**, **Section 2 (Plan & Test Strategy)**, and **Section 3 (Checklist)**.
|
|
49
|
+
2. **Implement (`/implement`)**:
|
|
50
|
+
- Executes checklist tasks incrementally one small diff at a time using **TDD (Red-Green-Refactor)**.
|
|
51
|
+
- Updates `## 4. Implementation Record` and marks tasks `- [x]` in `current-feature.md`.
|
|
52
|
+
3. **Check (`/check`)**:
|
|
53
|
+
- Senior QA multi-lane verification (Lane 1: Typecheck/Lint, Lane 2: Test Suites, Lane 3: Manual Proof).
|
|
54
|
+
- Records empirical proof under `## 5. Verification Evidence` in `current-feature.md`.
|
|
55
|
+
4. **Complete (`/complete`)**:
|
|
56
|
+
- Final safety pass, updates `## 6. Release & Handoff` digest in `current-feature.md`.
|
|
57
|
+
- Automatically archives `current-feature.md` ➔ `devflow/history/{features|fixes|rollbacks}/{xxx-slug}.md`.
|
|
58
|
+
- Appends resolved findings and cleans `findings.md`.
|
|
59
|
+
- Resets `current-feature.md` back to the idle stub.
|
|
60
|
+
- Performs Git squash-merge into `main`, updates `devflow/history/HISTORY.md`, and sets workspace to Idle.
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
### 🏗️ Track 2: Deep-Track (Architect Mode — 8 Steps)
|
|
65
|
+
*Recommended for large architectural epics, database migrations, security audits, and multi-agent coordination.*
|
|
66
|
+
|
|
67
|
+
```text
|
|
68
|
+
00-discover ➔ 10-define ➔ 20-spec ➔ 30-plan ➔ 40-execute ➔ 50-verify ➔ 60-report ➔ 70-release
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
1. `00-discover`: Explore request before delivery commitment (`DISC-YYYYMMDD-NNN`).
|
|
72
|
+
2. `10-define`: Turn approved discovery into bounded delivery run in `devflow/context/current-run/10-define.md`.
|
|
73
|
+
3. `20-spec`: Formalize markdown 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-execute`: Incremental task execution behind review gates (`40-execute.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, git merge, archives `devflow/context/current-run/` ➔ `devflow/history/{features|fixes|rollbacks}/{xxx-slug}/`, and closes the run.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## 4. Standalone HTML Reporting Policy
|
|
83
|
+
|
|
84
|
+
> [!IMPORTANT]
|
|
85
|
+
> **No Auto-Generated HTML**: Mainline stages (`/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 -- {ID}`).
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## 5. Resuming After Context Clear
|
|
92
|
+
|
|
93
|
+
Progress lives in persistent files, not in transient chat history:
|
|
94
|
+
|
|
95
|
+
- In Fast-Track: `devflow/context/current-feature.md` maintains ticked checklist boxes `- [x]`.
|
|
96
|
+
- In Deep-Track: `devflow/context/current-run/` maintains stage markdown files.
|
|
97
|
+
- In Git: Commits, branches, and working tree maintain the code history.
|
|
98
|
+
- When starting a fresh session after a context clear, run `devflow` or inspect `current-stage.md` to pick up immediately from the next pending step.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## 6. Single Active Run Guardrail (One Thing at a Time)
|
|
103
|
+
|
|
104
|
+
- Only one active run is allowed at a time across both Fast-Track and Deep-Track.
|
|
105
|
+
- The AI will actively block opening a new feature or fix until the current one is completed with `/complete` or `70-release` (or explicitly rolled back/cancelled).
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## 7. Branching & Git Conventions
|
|
110
|
+
|
|
111
|
+
- **Branch Naming**: `feature/{xxx-slug}` or `fix/{xxx-slug}`.
|
|
112
|
+
- **Commit Messages**: Conventional imperative format (e.g. `feat(uninstall): add clean eject CLI command`, `fix(parser): handle undefined metadata field`).
|
|
113
|
+
- **No AI Attribution in Commits**: Never include "Generated with AI" or agent metadata in Git commit logs.
|
|
114
|
+
- **Explicit Approval for Push & Deploy**: Merge approval is strictly separate from consent to `git push` to remote repositories or deploy to production.
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## 8. Autopilot Policy
|
|
119
|
+
|
|
120
|
+
- `autopilot` is an explicit opt-in command (`/autopilot`). Never suggest it as the default next action.
|
|
121
|
+
- When invoked, it runs one bounded spec/plan/implement/verify pass.
|
|
122
|
+
- Autopilot **MUST stop** before `/complete`, merge, push, deploy, or any destructive action.
|
|
@@ -1,40 +1,131 @@
|
|
|
1
|
-
# Coding Standards & Guidelines
|
|
1
|
+
# Coding Standards & Engineering Guidelines
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> Engineering standards, architecture conventions, testing policies, and code quality guidelines for **Nexus-DevFlow**.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
---
|
|
6
6
|
|
|
7
|
-
|
|
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.
|
|
7
|
+
## 1. TypeScript & Runtime Standards
|
|
11
8
|
|
|
12
|
-
|
|
9
|
+
- **Strict Mode Enabled**: Always adhere to strict TypeScript compilation (`"strict": true` in `tsconfig.json`).
|
|
10
|
+
- **No `any` Types**: Prohibit the use of `any`. Use precise interface definitions, generics, or `unknown` with runtime type narrowing.
|
|
11
|
+
- **Type Definitions**: Define clear interfaces and types for all function options, CLI arguments, parse results, and data payloads.
|
|
12
|
+
- **Type Inference vs. Explicit Types**: Use type inference for straightforward local variables, and explicit return types for public functions, exports, and complex utilities.
|
|
13
|
+
- **ESM-First Architecture**: Use native Node.js ESM (`"type": "module"`). Always use explicit `node:` protocol imports (e.g. `node:fs`, `node:path`, `node:os`, `node:child_process`).
|
|
13
14
|
|
|
14
|
-
|
|
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.
|
|
15
|
+
---
|
|
17
16
|
|
|
18
|
-
##
|
|
17
|
+
## 2. CLI Architecture & Engineering Principles
|
|
19
18
|
|
|
20
|
-
-
|
|
19
|
+
- **Separation of Concerns (Deep Modules)**:
|
|
20
|
+
- Keep CLI entry points (`bin/create-nexus-devflow.ts`) thin: handle argument parsing, option normalization, and terminal formatting.
|
|
21
|
+
- Encapsulate all core business logic, filesystem operations, and parsing inside modular libraries (`lib/current-work.ts`, `lib/findings.ts`, `lib/git.ts`, `lib/uninstall.ts`, `lib/update.ts`).
|
|
22
|
+
- **Safety Flags & Idempotency**:
|
|
23
|
+
- Destructive or mutating operations (e.g. `uninstall`, `update`, `install`) must support safety flags:
|
|
24
|
+
- `--dry-run`: Preview actions and affected files without modifying the disk.
|
|
25
|
+
- `-y`, `--yes`, `-f`, `--force`: Non-interactive mode for CI/CD automation.
|
|
26
|
+
- `--json`: Machine-readable structured output for integrations.
|
|
27
|
+
- **Cross-Platform Compatibility**:
|
|
28
|
+
- Never assume POSIX-only paths or Windows-only backslashes. Always use `path.join()`, `path.resolve()`, or normalize paths with forward slashes for URLs and identifiers.
|
|
29
|
+
- Handle Windows permission quirks (EPERM, EBUSY) with graceful retries or clear explanatory messages.
|
|
30
|
+
- **Terminal UX & ANSI Formatting**:
|
|
31
|
+
- Provide clear, high-contrast, and aesthetic terminal outputs.
|
|
32
|
+
- Automatically respect `process.stdout.isTTY` and support `--no-color` / `NO_COLOR` environment variables.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 3. File Organization & Directory Structure
|
|
37
|
+
|
|
38
|
+
```text
|
|
39
|
+
nexus-devflow/
|
|
40
|
+
├── .agents/skills/ # Codex & Google Antigravity skill definitions
|
|
41
|
+
├── .claude/skills/ # Claude Code mirrored skill adapters
|
|
42
|
+
├── .nexus/ # Metadata tracking & upstream baseline ledger
|
|
43
|
+
├── devflow/ # Framework workspace context, runs, and discoveries
|
|
44
|
+
│ ├── context/ # Living source-of-truth context files
|
|
45
|
+
│ ├── discoveries/ # Pre-delivery discovery records (00-discover.md)
|
|
46
|
+
│ ├── runs/ # Running delivery artifacts (current-feature.md / 00-70)
|
|
47
|
+
│ ├── history/ # Master delivery archive (HISTORY.md)
|
|
48
|
+
│ └── ideas.md # Idea Inbox and backlog
|
|
49
|
+
├── packages/
|
|
50
|
+
│ └── create-nexus-devflow/ # Distribution npm package source
|
|
51
|
+
│ ├── bin/ # CLI executable binaries
|
|
52
|
+
│ ├── lib/ # Modular domain libraries
|
|
53
|
+
│ └── test/ # Automated unit tests (*.test.ts)
|
|
54
|
+
└── scripts/ # Maintainer verification & automation scripts
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## 4. Naming Conventions
|
|
60
|
+
|
|
61
|
+
- **Files & Directories**:
|
|
62
|
+
- Skills and command directories: `kebab-case` (e.g. `00-discover`, `report-html`, `sync-upstream`).
|
|
63
|
+
- Source modules and scripts: `kebab-case.ts` / `kebab-case.mjs` (e.g. `current-work.ts`, `check-devflow.ts`).
|
|
64
|
+
- Test files: `[module].test.ts` (e.g. `status.test.ts`, `uninstall.test.ts`).
|
|
65
|
+
- **Identifiers**:
|
|
66
|
+
- Functions & methods: `camelCase` (e.g. `parseCurrentWork`, `applyUninstall`, `readProjectStatus`).
|
|
67
|
+
- Variables & properties: `camelCase`.
|
|
68
|
+
- Types & Interfaces: `PascalCase` without prefixes like `I` or `T` (e.g. `ProjectStatus`, `RunWorkSummary`).
|
|
69
|
+
- Constants & Enums: `SCREAMING_SNAKE_CASE` (e.g. `LEGACY_FEATURE_PATH`, `DEFAULT_ADAPTERS`).
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## 5. Testing & Empirical Proof Standards
|
|
74
|
+
|
|
75
|
+
Testing is a core quality gate in Nexus-DevFlow, not an afterthought:
|
|
76
|
+
|
|
77
|
+
- **Unit Test Mandate**: Any new feature, modified logic, parser improvement, or bug fix **MUST ship with automated unit tests** in the same diff.
|
|
78
|
+
- **Test Framework**: Use Node.js native test runner executed via `tsx --test test/*.test.ts` under `packages/create-nexus-devflow/`.
|
|
79
|
+
- **Test Design (AAA Pattern)**:
|
|
80
|
+
- Structure each test case cleanly: **Arrange** (setup fixtures/mock directories), **Act** (execute function), **Assert** (verify invariants).
|
|
81
|
+
- Use isolated temporary directories (`fs.mkdtemp` in `os.tmpdir()`) and ensure cleanup in `finally` blocks.
|
|
82
|
+
- **Empirical Proof Contract**:
|
|
83
|
+
- Never claim a task is "working", "tested", or "verified" without providing concrete empirical proof (exact command executed, terminal output, pass/fail counts, exit code).
|
|
84
|
+
- **3-Lane Verification Matrix**:
|
|
85
|
+
- **Lane 1 (Type & Syntax Safety)**: `tsc --noEmit` (0 type errors).
|
|
86
|
+
- **Lane 2 (Automated Test Suites & Evals)**: `npm test` (Unit tests 100% pass) + `npm run test:routing` (Skill routing accuracy).
|
|
87
|
+
- **Lane 3 (Manual / Scenario Proof)**: Concrete walkthrough steps ("Where to go", "What to run", "What to expect").
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## 6. Findings Ledger & Quality Gates (`findings.md`)
|
|
92
|
+
|
|
93
|
+
- All quality defects, security findings, or regression issues identified during review must be logged in `devflow/context/findings.md`.
|
|
21
94
|
- **Finding State Machine**:
|
|
22
|
-
- `open`: Confirmed
|
|
23
|
-
- `fixed`: Repaired in code, pending verification.
|
|
24
|
-
- `closed`: Verified
|
|
25
|
-
- `accepted`:
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
95
|
+
- `open`: Confirmed issue waiting to be fixed.
|
|
96
|
+
- `fixed`: Repaired in code, pending QA re-verification.
|
|
97
|
+
- `closed`: Verified by QA as completely resolved without regressions.
|
|
98
|
+
- `accepted`: Formally waived with recorded user justification.
|
|
99
|
+
- **P0/P1 Blockers**: Any P0 or P1 finding in `open` or `fixed` status unconditionally blocks `/complete` and `70-release`.
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## 7. Error Handling & Exit Codes
|
|
104
|
+
|
|
105
|
+
- Use structured `try / catch` blocks around filesystem and process operations.
|
|
106
|
+
- Create meaningful, actionable error messages for the user (explain what failed and how to resolve it).
|
|
107
|
+
- Exit cleanly with standard POSIX process exit codes:
|
|
108
|
+
- `0`: Successful execution.
|
|
109
|
+
- `1`: Validation failure, missing arguments, or runtime error.
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## 8. Comments & Documentation Discipline
|
|
114
|
+
|
|
115
|
+
Write code that explains itself; comment only what the code cannot say:
|
|
116
|
+
|
|
117
|
+
- Comment the **why**, not the **what**. Avoid comments that simply rephrase the line of code.
|
|
118
|
+
- Avoid noisy banner blocks, section divider lines (`// ====================`), or obvious step narrations.
|
|
119
|
+
- Comments earn their place when documenting:
|
|
120
|
+
- Non-obvious architectural decisions.
|
|
121
|
+
- Upstream compatibility quirks or workarounds.
|
|
122
|
+
- Edge-case handling rationale.
|
|
123
|
+
- Keep JSDoc minimal and useful: provide a one-line summary and document non-obvious parameters.
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## 9. Writing & Language Conventions
|
|
128
|
+
|
|
129
|
+
- **Default Communication & Artifacts**: Thai (`th`) for all generated markdown stage artifacts (`current-feature.md`, `00-discover.md`, etc.), explanations, and user interactions.
|
|
130
|
+
- **Code & Identifiers**: English for all source code, variable names, file paths, CLI flags, and commit messages.
|
|
131
|
+
- **Typography**: Do not use em dashes (`—`) in AI-generated commit messages or technical summaries; use standard hyphens (`-`) or colons.
|