@jakkrichm/create-nexus-devflow 2.18.1 → 2.19.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 +7 -6
- package/dist/bin/create-nexus-devflow.js +80 -47
- package/dist/bin/create-nexus-devflow.js.map +1 -1
- package/dist/lib/doctor.js +27 -0
- package/dist/lib/doctor.js.map +1 -1
- package/dist/lib/skill-manager.d.ts +2 -2
- package/dist/lib/skill-manager.js +2 -2
- package/dist/lib/skill-manager.js.map +1 -1
- package/dist/lib/skill-registry-engine.d.ts +5 -0
- package/dist/lib/skill-registry-engine.js +39 -5
- package/dist/lib/skill-registry-engine.js.map +1 -1
- package/dist/lib/tooling/commands/scan-doc-contract.js +0 -1
- package/dist/lib/tooling/commands/scan-doc-contract.js.map +1 -1
- package/dist/lib/ui.d.ts +23 -0
- package/dist/lib/ui.js +85 -0
- package/dist/lib/ui.js.map +1 -1
- package/dist/lib/update.js +1 -1
- package/dist/lib/update.js.map +1 -1
- package/dist/scripts/prepare-template.js +3 -7
- package/dist/scripts/prepare-template.js.map +1 -1
- package/package.json +2 -2
- package/template/.agents/skills/audit/SKILL.md +4 -1
- package/template/.agents/skills/brainstorm/SKILL.md +5 -4
- package/template/.agents/skills/bughunter/SKILL.md +1 -1
- package/template/.agents/skills/check/SKILL.md +26 -116
- package/template/.agents/skills/check/reference/guide.md +36 -4
- package/template/.agents/skills/check/reference/verify.md +129 -0
- package/template/.agents/skills/ci/SKILL.md +35 -13
- package/template/.agents/skills/complete/SKILL.md +2 -0
- package/template/.agents/skills/devflow/SKILL.md +3 -2
- package/template/.agents/skills/discovery/SKILL.md +9 -0
- package/template/.agents/skills/doctor/SKILL.md +2 -0
- package/template/.agents/skills/explore/SKILL.md +2 -1
- package/template/.agents/skills/feature/SKILL.md +4 -1
- package/template/.agents/skills/feature/reference/feature-spec-template.md +16 -16
- package/template/.agents/skills/fix/SKILL.md +3 -3
- package/template/.agents/skills/grill/SKILL.md +6 -1
- package/template/.agents/skills/idea/SKILL.md +6 -6
- package/template/.agents/skills/implement/SKILL.md +45 -119
- package/template/.agents/skills/test/SKILL.md +26 -0
- package/template/.claude/skills/audit/SKILL.md +4 -1
- package/template/.claude/skills/brainstorm/SKILL.md +5 -4
- package/template/.claude/skills/bughunter/SKILL.md +1 -1
- package/template/.claude/skills/check/SKILL.md +26 -116
- package/template/.claude/skills/check/reference/guide.md +36 -4
- package/template/.claude/skills/check/reference/verify.md +129 -0
- package/template/.claude/skills/ci/SKILL.md +35 -13
- package/template/.claude/skills/complete/SKILL.md +2 -0
- package/template/.claude/skills/devflow/SKILL.md +3 -2
- package/template/.claude/skills/discovery/SKILL.md +11 -3
- package/template/.claude/skills/doctor/SKILL.md +2 -0
- package/template/.claude/skills/explore/SKILL.md +2 -1
- package/template/.claude/skills/feature/SKILL.md +4 -1
- package/template/.claude/skills/feature/reference/feature-spec-template.md +16 -16
- package/template/.claude/skills/fix/SKILL.md +3 -3
- package/template/.claude/skills/grill/SKILL.md +6 -1
- package/template/.claude/skills/idea/SKILL.md +6 -6
- package/template/.claude/skills/implement/SKILL.md +45 -119
- package/template/.claude/skills/test/SKILL.md +26 -0
- package/template/AGENTS.md +27 -38
- package/template/devflow/context/ai-interaction.md +15 -14
- package/template/devflow/context/coding-standards.md +67 -6
- package/template/devflow/context/glossary.md +26 -6
- package/template/devflow/decisions/README.md +15 -1
- package/template/devflow/reference/feature-spec-template.md +59 -79
- package/template/devflow/reference/help-playbook-protocol.md +33 -0
- package/template/devflow/reference/slicing-archetypes.md +105 -0
- package/template/devflow/docs/USAGE.md +0 -195
- package/template/devflow/docs/diagrams/nexus-devflow-architecture.html +0 -14821
- package/template/devflow/docs/diagrams/nexus-devflow-architecture.json +0 -80
- package/template/devflow/docs/diagrams/nexus-devflow-lifecycle.html +0 -14860
- package/template/devflow/docs/diagrams/nexus-devflow-lifecycle.json +0 -88
- package/template/devflow/docs/examples/living-spec/adr.example.md +0 -43
- package/template/devflow/docs/examples/living-spec/current-feature.example.md +0 -113
- package/template/devflow/docs/examples/living-spec/discovery.example.md +0 -45
- package/template/devflow/docs/examples/living-spec/ideas.example.md +0 -22
- package/template/devflow/docs/governance-rules.md +0 -39
- package/template/devflow/docs/manual-review-workflow-spec.md +0 -116
- package/template/devflow/docs/markdown-metadata-contract.md +0 -140
- package/template/devflow/docs/quickstart.md +0 -124
- package/template/devflow/docs/release-process.md +0 -52
- package/template/devflow/docs/skill-selection-policy.md +0 -64
- package/template/devflow/docs/workflow-surface-map.md +0 -86
- package/template/devflow/runs/.gitkeep +0 -1
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ci
|
|
3
|
-
description: "[devflow] Set up or normalize one project Verify command and matching GitHub Actions checks while preserving existing CI. Use for /ci, GitHub Actions setup, pull-request checks, automatic checks, or aligning verification."
|
|
3
|
+
description: "[devflow] Set up or normalize one project Verify command and matching GitHub Actions checks while preserving existing CI, with an optional local pre-push hook. Use for /ci, GitHub Actions setup, pull-request checks, automatic checks, pre-push hooks, or aligning verification."
|
|
4
|
+
argument-hint: "[--hook | --no-hook]"
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
# ci - set up automatic GitHub checks
|
|
7
8
|
|
|
9
|
+
**Context reuse:** Reuse any required file already loaded in project instructions or the current session. Read it again only if absent, changed, or exact current bytes or line references are needed.
|
|
10
|
+
|
|
8
11
|
**First action:** Before project inspection, preflight, or any other tool call,
|
|
9
12
|
publish `running` to `devflow/.state/run.json` using the dashboard activity
|
|
10
13
|
contract in `AGENTS.md`.
|
|
@@ -15,7 +18,7 @@ Where this sits in the workflow:
|
|
|
15
18
|
(project commands) (setup) (same recipe) (pull requests)
|
|
16
19
|
|
|
17
20
|
This skill gives local work and GitHub one shared automated command. It is an
|
|
18
|
-
optional setup task, not a requirement for using
|
|
21
|
+
optional setup task, not a requirement for using DevFlow.
|
|
19
22
|
|
|
20
23
|
Keep the beginner explanation simple:
|
|
21
24
|
|
|
@@ -23,9 +26,12 @@ Keep the beginner explanation simple:
|
|
|
23
26
|
- **GitHub Actions is the worker.** It runs the same recipe automatically.
|
|
24
27
|
- **A GitHub ruleset is the lock.** That optional remote setting can require the
|
|
25
28
|
worker to report green before merge.
|
|
29
|
+
- **A pre-push hook is the early warning.** That optional local setting runs the
|
|
30
|
+
recipe before a push leaves the machine. It is a convenience, not the lock:
|
|
31
|
+
`git push --no-verify` skips it.
|
|
26
32
|
|
|
27
|
-
This skill configures the recipe and worker
|
|
28
|
-
pushes, publishes,
|
|
33
|
+
This skill configures the recipe and worker, and adds the hook only when the
|
|
34
|
+
user opts in. It never changes the remote ruleset, pushes, publishes, or deploys.
|
|
29
35
|
|
|
30
36
|
## Input
|
|
31
37
|
|
|
@@ -47,7 +53,7 @@ Read enough to identify the real project setup:
|
|
|
47
53
|
- `.github/workflows/` and any documented external CI
|
|
48
54
|
- git's current branch, configured default branch, and remotes when available
|
|
49
55
|
|
|
50
|
-
Do not assume npm, Node.js, `main`, or GitHub from the
|
|
56
|
+
Do not assume npm, Node.js, `main`, or GitHub from the DevFlow template. Do not
|
|
51
57
|
run installs or edit files during inspection.
|
|
52
58
|
|
|
53
59
|
If an existing workflow already provides equivalent pull-request checks, explain
|
|
@@ -113,11 +119,26 @@ After the workflow exists, ask one question and default to no:
|
|
|
113
119
|
|
|
114
120
|
Also add a local pre-push hook that runs Verify before every push? [y/N]
|
|
115
121
|
|
|
116
|
-
Skip the question when the request already answered it (for example "/ci with
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
122
|
+
Skip the question when the request already answered it (for example "/ci with
|
|
123
|
+
hook" or "no hook"). When the answer is no, write nothing and move on. When it
|
|
124
|
+
is yes:
|
|
125
|
+
|
|
126
|
+
1. Use `npx nexus-devflow hook install pre-push` or manually write `.githooks/pre-push`
|
|
127
|
+
(mode 755) that announces itself and runs the exact `Verify` command from `AGENTS.md`
|
|
128
|
+
with `exec`, so the command's exit code is the hook's exit code.
|
|
129
|
+
2. Point git at the folder: `git config core.hooksPath .githooks`.
|
|
130
|
+
3. For JavaScript and TypeScript projects, add a `prepare` script,
|
|
131
|
+
`git config core.hooksPath .githooks 2>/dev/null || true`, so a fresh
|
|
132
|
+
install wires the hook without a manual step. The `|| true` keeps installs
|
|
133
|
+
working where no git checkout exists, such as a deploy build. For other
|
|
134
|
+
stacks, document the `git config` line in the README instead.
|
|
135
|
+
4. Run the hook once (`.githooks/pre-push`). If it fails, remove what this
|
|
136
|
+
step added and report the failing subcommand. Never leave a hook the
|
|
137
|
+
project cannot pass.
|
|
138
|
+
|
|
139
|
+
The hook and the workflow run the same `Verify` command; if one changes, the
|
|
140
|
+
other changes with it. Say in the report that `--no-verify` bypasses the hook,
|
|
141
|
+
so the GitHub ruleset remains the lock.
|
|
121
142
|
|
|
122
143
|
## Step 4 - prove the setup locally
|
|
123
144
|
|
|
@@ -146,6 +167,7 @@ Finish with a concise setup report:
|
|
|
146
167
|
- checks included and checks omitted
|
|
147
168
|
- test gate status
|
|
148
169
|
- workflow path and triggers
|
|
170
|
+
- whether a pre-push hook was added, and that `--no-verify` bypasses it
|
|
149
171
|
- local Verify result and whether CI is only prepared locally or confirmed by a
|
|
150
172
|
successful GitHub run
|
|
151
173
|
- files changed
|
|
@@ -157,7 +179,7 @@ part of this skill.
|
|
|
157
179
|
|
|
158
180
|
## Interaction with other skills
|
|
159
181
|
|
|
160
|
-
- `/tests` adds the real test command to an existing Verify command, but never
|
|
182
|
+
- `/setup-tests` or `/test` adds the real test command to an existing Verify command, but never
|
|
161
183
|
creates CI by itself.
|
|
162
184
|
- `/implement`, `/complete`, and `/autopilot` run Verify when it is documented,
|
|
163
185
|
with their existing fallback behavior when it is absent.
|
|
@@ -168,8 +190,8 @@ part of this skill.
|
|
|
168
190
|
|
|
169
191
|
- Preserve existing CI and custom checks.
|
|
170
192
|
- Never invent tests or install a runner as part of CI setup.
|
|
171
|
-
- Never add
|
|
172
|
-
|
|
193
|
+
- Never add coverage, browser tests, security scans, or matrices by default.
|
|
194
|
+
- Add a git hook only through the Step 3b opt-in, never silently.
|
|
173
195
|
- Never push or change a remote ruleset without separate explicit approval.
|
|
174
196
|
- Keep one exact Verify command shared by local work and GitHub.
|
|
175
197
|
|
|
@@ -106,6 +106,8 @@ Before logging or committing, run a short safety pass and report blockers only:
|
|
|
106
106
|
- no P0 or P1 finding in `devflow/context/{xxx-slug}/findings.md` is `open` or `fixed`.
|
|
107
107
|
`fixed` still blocks on purpose: the repair exists but no review has looked at
|
|
108
108
|
it - run `/audit` to close it. The only waivers are `accepted` or `invalid`.
|
|
109
|
+
- any `Status: Assumed` ADR in `devflow/decisions/` has been surfaced with its ratification plan noted.
|
|
110
|
+
|
|
109
111
|
|
|
110
112
|
Do not claim "passed", "verified", or "working" without naming the command,
|
|
111
113
|
route, screenshot, or output that proves it. Stop before Step 1 if required
|
|
@@ -36,7 +36,8 @@ When invoked without an argument (or when determining the next step), inspect:
|
|
|
36
36
|
|
|
37
37
|
### Default State Recommendations
|
|
38
38
|
- If no run is active and user wants to start a feature -> Recommend `/feature <name>`.
|
|
39
|
-
- If
|
|
39
|
+
- If the user requests a bugfix plan -> Recommend `/fix <bug>`.
|
|
40
|
+
- If the user requests a completed fix -> preserve the implementation and verification scope; draft the required spec internally and continue to `/implement` using existing authorization.
|
|
40
41
|
- If no run is active and user has pending ideas in `devflow/ideas.md` -> Highlight `/feature IDEA-xxx` or `/discovery IDEA-xxx`.
|
|
41
42
|
- If no run is active and user wants deep architectural exploration -> Recommend `/discovery`.
|
|
42
43
|
- If user asks to check system health -> Recommend `doctor`.
|
|
@@ -48,7 +49,7 @@ When invoked without an argument (or when determining the next step), inspect:
|
|
|
48
49
|
| User Intent / Request Type | Recommended Skill | Normal Name / Alias | Lifecycle Path |
|
|
49
50
|
| :--- | :--- | :--- | :--- |
|
|
50
51
|
| **"Spec new feature / living spec"** | `feature` | `/feature` / `/spec` | **Unified**: `/feature` -> `/implement` -> `/check` -> `/complete` |
|
|
51
|
-
| **"
|
|
52
|
+
| **"Draft a bugfix / small-change plan"** | `fix` | `/fix` | **Unified**: `/fix` -> `/implement` -> `/check` -> `/complete` |
|
|
52
53
|
| **"Capture quick idea / thought"** | `idea` | `/idea` | **Companion**: Enriches & saves to `devflow/ideas.md` |
|
|
53
54
|
| **"Pre-delivery exploration / research"**| `discovery`| `/discovery` | **Pre-Flight**: `discovery` -> `/feature` |
|
|
54
55
|
| **"Socratic alignment / ADR / glossary"**| `grill` | `/grill` / `/align` | **Pre-Flight**: `grill` -> `/feature` |
|
|
@@ -81,6 +81,15 @@ devflow/discoveries/{DISCOVERY_ID}-{slug}/discovery.md
|
|
|
81
81
|
- **For interactive system architecture, dataflows, state transitions, and sequence traces**: Use `archify` (`.agents/skills/archify/SKILL.md`) to compile validated interactive HTML artifacts with dark/light themes, motion, and route probes.
|
|
82
82
|
- **For editorial, business, quadrant, or broad diagram types**: Use `diagram-design` (`.agents/skills/diagram-design/SKILL.md`).
|
|
83
83
|
- Save diagram artifacts to `devflow/discoveries/{DISCOVERY_ID}-{slug}/diagrams/{name}.html` and reference them directly in `discovery.md`.
|
|
84
|
+
7. **🧩 Slicing & Decomposition Lens (4 Slicing Archetypes)**:
|
|
85
|
+
- When breaking down a large initiative into sub-features or milestones, evaluate against [`devflow/reference/slicing-archetypes.md`](file:///d:/Projects/devtools/nexus-devflow/devflow/reference/slicing-archetypes.md):
|
|
86
|
+
- **Skateboard**: Minimal functional loop (prove core logic end-to-end with minimal UI).
|
|
87
|
+
- **Facade**: Rich UI/DX with mock backend (validate user flow & interaction first).
|
|
88
|
+
- **Tracer Bullet**: Deep vertical slice across all layers (DB -> API -> UI) for 1 happy path.
|
|
89
|
+
- **Journey**: Slice along natural user workflow milestones.
|
|
90
|
+
- Recommend the primary Archetype for each proposed sub-feature in `discovery.md`.
|
|
91
|
+
|
|
92
|
+
|
|
84
93
|
|
|
85
94
|
### Decision & Approval Gate:
|
|
86
95
|
Set one visible decision:
|
|
@@ -166,6 +166,8 @@ Gather these, then summarize. Do not dump file contents.
|
|
|
166
166
|
last commit subject, and whether the branch is ahead of upstream.
|
|
167
167
|
- If the directory is not a git repo, report that as a setup issue and keep
|
|
168
168
|
going.
|
|
169
|
+
9. **Token Economics & Session Cost Audit**
|
|
170
|
+
- When session transcript is available, report token efficiency, cache hit rate, and estimated model costs using `npm run analyze:tokens` or `scripts/analyze-token-usage.ts`.
|
|
169
171
|
|
|
170
172
|
## Output
|
|
171
173
|
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: explore
|
|
3
3
|
description: "[devflow] Explore an idea against the actual codebase without changing files. Investigate whether a change would help, compare alternatives and tradeoffs, and discuss uncertainty before deciding whether to plan anything. Use for /explore, considering an idea, or weighing options without writing a spec."
|
|
4
|
+
argument-hint: "[<idea or question>]"
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
# explore - investigate an idea before deciding to build (Read-Only)
|
|
@@ -79,4 +80,4 @@ let the discussion continue as long as useful.
|
|
|
79
80
|
Suggest the appropriate command only when the user is ready to proceed.
|
|
80
81
|
|
|
81
82
|
Do not force a handoff at the end of every response. Keep discussing the idea
|
|
82
|
-
|
|
83
|
+
until the user decides what to do next.
|
|
@@ -102,6 +102,8 @@ the data model, stack, and conventions. Decide how big the feature is:
|
|
|
102
102
|
those sub-items back under the parent in `build-plan.md` as an indented
|
|
103
103
|
checklist (`4a`, `4b`, `4c` ...). Spec only the **first** sub-feature now; the
|
|
104
104
|
rest get picked up on later `/feature` runs.
|
|
105
|
+
*Use the **4 Slicing Archetypes** ([`devflow/reference/slicing-archetypes.md`](file:///d:/Projects/devtools/nexus-devflow/devflow/reference/slicing-archetypes.md)) to guide the split: 🛹 Skateboard (core logic first), 🎭 Facade (UI/DX mock first), 🎯 Tracer Bullet (end-to-end slice), or 🧭 Journey (workflow steps).*
|
|
106
|
+
|
|
105
107
|
|
|
106
108
|
Two levels of breakdown - don't confuse them:
|
|
107
109
|
|
|
@@ -198,7 +200,7 @@ Before the user reads it, turn on the spec yourself and try to break it. The
|
|
|
198
200
|
cheapest place to catch a scope problem or an oversized step is here, before any
|
|
199
201
|
code exists. Run the draft against these questions:
|
|
200
202
|
|
|
201
|
-
- **Coverage.** What does this feature need that no step delivers? Push on the
|
|
203
|
+
- **Coverage & Input Mapping.** What does this feature need that no step delivers? Run a mechanical **Input Coverage Test**: does every value this build produces, displays, or computes have a named source (input, DB column, formula, or settled decision) in the spec? Push on the
|
|
202
204
|
unhappy paths the happy-path spec skipped: empty / missing / malformed input,
|
|
203
205
|
the error / loading / empty states, the first-run case, failure of anything
|
|
204
206
|
external it calls.
|
|
@@ -218,6 +220,7 @@ code exists. Run the draft against these questions:
|
|
|
218
220
|
anything pushed to "out of scope" that this feature actually can't ship without?
|
|
219
221
|
- **Done-whens.** Is each one observable and checkable by `/check`, or is it a
|
|
220
222
|
vague "it works"? Make it concrete.
|
|
223
|
+
- **Proportionality.** Does any proposed abstraction, dependency, service, config surface, or security mechanism lack a current requirement, or duplicate existing code/platform features? If so, remove it.
|
|
221
224
|
- **Testing.** Does the predicted coverage match the gate - in-scope logic gets a
|
|
222
225
|
test when a `test` command is declared in `AGENTS.md`, UI/integration rides on
|
|
223
226
|
screenshot + build?
|
|
@@ -14,18 +14,18 @@
|
|
|
14
14
|
## 1. Specification & Scope
|
|
15
15
|
|
|
16
16
|
### 1.1 Problem Statement
|
|
17
|
-
{
|
|
17
|
+
{Description of the problem, background, and rationale for developing this feature}
|
|
18
18
|
|
|
19
19
|
### 1.2 In-Scope
|
|
20
|
-
1. {
|
|
21
|
-
2. {
|
|
20
|
+
1. {In-scope item 1}
|
|
21
|
+
2. {In-scope item 2}
|
|
22
22
|
|
|
23
23
|
### 1.3 Out-of-Scope
|
|
24
|
-
- {
|
|
24
|
+
- {Items deliberately excluded or deferred to future features}
|
|
25
25
|
|
|
26
|
-
### 1.4 Acceptance Criteria
|
|
27
|
-
- [ ] **AC-1**: {
|
|
28
|
-
- [ ] **AC-2**: {
|
|
26
|
+
### 1.4 Acceptance Criteria
|
|
27
|
+
- [ ] **AC-1**: {Acceptance criterion 1}
|
|
28
|
+
- [ ] **AC-2**: {Acceptance criterion 2}
|
|
29
29
|
|
|
30
30
|
---
|
|
31
31
|
|
|
@@ -40,18 +40,18 @@
|
|
|
40
40
|
- **Review Strategy**: One feature-level review packet at completion
|
|
41
41
|
|
|
42
42
|
### 2.3 Test Decision: Required (TDD) | Optional
|
|
43
|
-
- **Rationale**: {
|
|
43
|
+
- **Rationale**: {Reason for requiring Unit Tests / TDD}
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
47
47
|
## 3. Implementation Checklist (Strict TDD)
|
|
48
48
|
|
|
49
|
-
- [ ] **Task 1: {
|
|
50
|
-
- [ ] 1.1 `[TDD-Red]`: {
|
|
51
|
-
- [ ] 1.2 `[TDD-Green]`: {
|
|
52
|
-
- [ ] 1.3 `[TDD-Refactor]`: {Refactor
|
|
49
|
+
- [ ] **Task 1: {Task 1 title}**
|
|
50
|
+
- [ ] 1.1 `[TDD-Red]`: {Write failing unit or behavioral test}
|
|
51
|
+
- [ ] 1.2 `[TDD-Green]`: {Write minimal implementation to pass test}
|
|
52
|
+
- [ ] 1.3 `[TDD-Refactor]`: {Refactor and ensure 100% tests green}
|
|
53
53
|
|
|
54
|
-
- [ ] **Task 2: {
|
|
54
|
+
- [ ] **Task 2: {Task 2 title}**
|
|
55
55
|
- [ ] 2.1 `[TDD-Red]`: ...
|
|
56
56
|
- [ ] 2.2 `[TDD-Green]`: ...
|
|
57
57
|
- [ ] 2.3 `[TDD-Refactor]`: ...
|
|
@@ -65,11 +65,11 @@
|
|
|
65
65
|
- **Automated Test Matrix**: TBD
|
|
66
66
|
- **Static Contract Verification**: TBD
|
|
67
67
|
- **Package Smoke Test**: TBD
|
|
68
|
-
- **Findings Ledger**:
|
|
68
|
+
- **Findings Ledger**: Verify `findings.md` is 100% clean
|
|
69
69
|
|
|
70
70
|
### 🎯 Axis 2: Spec Fidelity & Behavioral Acceptance Gate
|
|
71
|
-
- [ ] **AC-1**: {
|
|
72
|
-
- [ ] **AC-2**: {
|
|
71
|
+
- [ ] **AC-1**: {Empirical proof for AC-1}
|
|
72
|
+
- [ ] **AC-2**: {Empirical proof for AC-2}
|
|
73
73
|
|
|
74
74
|
---
|
|
75
75
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: fix
|
|
3
|
-
description: "[devflow]
|
|
3
|
+
description: "[devflow] Draft a task-isolated spec for a bug or small change. Use when invoking /fix or requesting a fix plan."
|
|
4
4
|
argument-hint: "[{title or issue-description}]"
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -23,7 +23,7 @@ it creates a dedicated run folder at `devflow/context/{xxx-slug}/` (e.g. `059-fi
|
|
|
23
23
|
## Input
|
|
24
24
|
|
|
25
25
|
A description of the bug or change, for example `/fix "password reset email never
|
|
26
|
-
sends"`.
|
|
26
|
+
sends"`. Use the reported problem as input when the user asks for a fix plan. A request to diagnose a problem belongs to `/debug`; a request to fix and verify it retains its full delivery scope.
|
|
27
27
|
|
|
28
28
|
The input may also be a finding ID from `devflow/context/{xxx-slug}/findings.md` (or previous findings), alone
|
|
29
29
|
or with a description, for example `/fix F-03`.
|
|
@@ -46,7 +46,7 @@ then write a short spec to `devflow/context/{xxx-slug}/spec.md`. Also initialize
|
|
|
46
46
|
big to read. Each ends with an observable "done when".
|
|
47
47
|
- **Verify** - how to confirm it's fixed (what to click or test).
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
For an explicit `/fix` or a planning-only request, present the spec as the completed deliverable and identify `/implement` as the next command. For an existing request to implement and verify the fix, preserve that authorization: use this spec as the internal handoff and continue through `/implement` without an extra approval pause. Ask only for unresolved material scope, design, or permission decisions.
|
|
50
50
|
|
|
51
51
|
## Rules
|
|
52
52
|
|
|
@@ -70,10 +70,14 @@ Allocate the next sequential ID (`ADR-001`, `ADR-002`, ...) and create `devflow/
|
|
|
70
70
|
```markdown
|
|
71
71
|
# ADR-xxx: {Title}
|
|
72
72
|
|
|
73
|
-
- **Status**: Accepted
|
|
73
|
+
- **Status**: Accepted | Assumed (Fast-tracked Assumption)
|
|
74
74
|
- **Date**: {YYYY-MM-DD}
|
|
75
75
|
- **Context**: {Why was this decision needed? What problem does it solve?}
|
|
76
76
|
- **Decision**: {What did we decide to do?}
|
|
77
|
+
- **Assumption Metadata** *(Required when Status is Assumed)*:
|
|
78
|
+
- **Assumption**: {What was assumed to unblock progress}
|
|
79
|
+
- **Risk Level & Blast Radius**: {Risk if assumption fails}
|
|
80
|
+
- **Ratification Plan**: {Trigger, date, or test to ratify as Accepted or Rejected}
|
|
77
81
|
- **Alternatives Considered**:
|
|
78
82
|
- *Option 1*: {Pros / Cons}
|
|
79
83
|
- *Option 2*: {Pros / Cons}
|
|
@@ -82,6 +86,7 @@ Allocate the next sequential ID (`ADR-001`, `ADR-002`, ...) and create `devflow/
|
|
|
82
86
|
- *Trade-offs / Risks*: {Costs, constraints, or follow-ups}
|
|
83
87
|
```
|
|
84
88
|
|
|
89
|
+
|
|
85
90
|
---
|
|
86
91
|
|
|
87
92
|
## 4. Closing & Handoff
|
|
@@ -26,7 +26,7 @@ When invoked:
|
|
|
26
26
|
3. Allocate the next sequential ID (e.g. `IDEA-001`, `IDEA-002`).
|
|
27
27
|
|
|
28
28
|
### 2. AI Feasibility & Value Analysis
|
|
29
|
-
Evaluate the user's raw idea and generate an enriched entry
|
|
29
|
+
Evaluate the user's raw idea and generate an enriched entry:
|
|
30
30
|
- **Raw Idea**: The user's input description
|
|
31
31
|
- **AI Feasibility & Tech**: Feasibility rating (Easy / Medium / Complex) along with recommended libraries, APIs, or architectural approaches
|
|
32
32
|
- **Value & Potential**: Business value, user benefits, and strategic impact
|
|
@@ -37,17 +37,17 @@ Insert the new idea block directly under `## 📌 Pending Ideas` in `devflow/ide
|
|
|
37
37
|
|
|
38
38
|
```markdown
|
|
39
39
|
### [IDEA-001] {Brief idea title}
|
|
40
|
-
-
|
|
41
|
-
-
|
|
40
|
+
- **Recorded Date**: {YYYY-MM-DD}
|
|
41
|
+
- **Original Idea**: {User's raw idea text}
|
|
42
42
|
- **AI Feasibility & Tech**: {Feasibility and tooling analysis}
|
|
43
43
|
- **Value & Potential**: {Value and impact analysis}
|
|
44
|
-
- **Quick Seed
|
|
44
|
+
- **Quick Seed**:
|
|
45
45
|
1. {Key point 1}
|
|
46
46
|
2. {Key point 2}
|
|
47
|
-
-
|
|
47
|
+
- **Status**: `Pending` (Ready for pickup via `/feature IDEA-001` or `/discovery IDEA-001`)
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
*(If placeholder `*(
|
|
50
|
+
*(If placeholder `*(No pending ideas...)*` exists, remove it upon recording the first idea)*
|
|
51
51
|
|
|
52
52
|
### 4. Output Summary
|
|
53
53
|
Report to the user:
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: implement
|
|
3
|
-
description: "[devflow]
|
|
3
|
+
description: "[devflow] Build and verify a task-isolated spec. Use for /implement or requests to implement an approved plan."
|
|
4
4
|
argument-hint: "[{run-id, number, or name}] [--ticket <NN | path>]"
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
# implement - build the target spec
|
|
7
|
+
# implement - build and verify the target spec
|
|
8
8
|
|
|
9
9
|
**Context reuse:** Reuse any required file already loaded in project instructions or the current session. Read it again only if absent, changed, or exact current bytes or line references are needed.
|
|
10
10
|
|
|
@@ -20,17 +20,23 @@ Where this sits in the workflow:
|
|
|
20
20
|
|
|
21
21
|
`/feature`, `/fix`, or `/rollback` wrote the spec to
|
|
22
22
|
`devflow/context/{xxx-slug}/spec.md` and stopped.
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
23
|
+
Build the selected spec through its acceptance criteria and required verification, then present the configured review handoff. Preserve authorization already given for this work. Read only relevant conventions and reuse loaded context.
|
|
24
|
+
|
|
25
|
+
## Review cadence and checkpoints
|
|
26
|
+
|
|
27
|
+
Read `workflow.stepReview` and `workflow.checkpointCommits` from `devflow/config.json` independently; defaults are `feature` and `disabled`.
|
|
28
|
+
|
|
29
|
+
- `stepReview: "feature"`: continue through all authorized steps without asking Continue after each step. Record evidence as work proceeds and present one final review packet.
|
|
30
|
+
- `stepReview: "every"`: after a working step, show its diff and evidence, then wait for approval before the next step. A walkthrough is available on request.
|
|
31
|
+
- `checkpointCommits: "disabled"`: omit ordinary checkpoint offers.
|
|
32
|
+
- `checkpointCommits: "enabled"`: offer an optional checkpoint at the configured review boundary (per-step for `every`, final packet for `feature`). Show the exact candidate and obtain commit authorization before committing. The setting itself is not authorization.
|
|
33
|
+
|
|
34
|
+
Independent-review checkpoints follow their separate contract below. Review cadence never authorizes commit, merge, push, or deployment.
|
|
29
35
|
|
|
30
36
|
## Multi-Run Target & Ticket-Driven Target Resolution
|
|
31
37
|
|
|
32
|
-
- **Given an ID or name** (e.g. `/implement 12`, `/implement 012`, `/implement kanban`) -> locates the matching run folder `devflow/context/{xxx-slug}/`,
|
|
33
|
-
- **With no argument** (`/implement`) -> checks current
|
|
38
|
+
- **Given an ID or name** (e.g. `/implement 12`, `/implement 012`, `/implement kanban`) -> locates the matching run folder `devflow/context/{xxx-slug}/`, selects the branch matching the run type and configured prefix, and loads only that run's `spec.md`.
|
|
39
|
+
- **With no argument** (`/implement`) -> checks the current feature, fix, or rollback branch against the configured prefixes, or auto-picks if only 1 spec is active in `devflow/context/`, or prompts the user if multiple specs are queued.
|
|
34
40
|
- **Ticket Input (`--ticket <NN | path>`)**: Targets a specific tracer-bullet ticket directly (e.g. `/implement 12 --ticket 01`, `/implement --ticket 02`, `/implement --ticket issues/01-auth.md`, or `/implement 01` when run-id is not ambiguous).
|
|
35
41
|
|
|
36
42
|
### Ticket Discovery Hierarchy
|
|
@@ -80,23 +86,23 @@ receipt. After the final Verify pass, an active gate routes to
|
|
|
80
86
|
`current` freshness may proceed toward `/complete`. This skill never approves
|
|
81
87
|
its own work or rewrites receipt evidence.
|
|
82
88
|
|
|
83
|
-
For
|
|
84
|
-
record the result in the step evidence. Use `browseros-neo` for the interactive
|
|
85
|
-
handoff when it is available and the done-when is visual or behavioral. When the
|
|
86
|
-
script or MCP is absent, report that exact limitation; do not silently install a
|
|
87
|
-
runner or claim browser evidence.
|
|
89
|
+
For browser-facing changes, run focused browser tests during iteration when available. Run the required `npm run test:browser` gate once before handoff if the spec or project requires it. Use `browseros-neo` for visual or behavioral evidence when available and relevant. Record missing tooling accurately; install a runner only when setup is in the authorized scope.
|
|
88
90
|
|
|
89
91
|
**Resuming?** If the spec already has some build steps checked off (`- [x]`), this
|
|
90
92
|
feature was started earlier and interrupted (often a cleared context). The spec and
|
|
91
93
|
its ticked steps are files, so pick up where it left off: read which steps are done,
|
|
92
94
|
check the git branch and `git status`/log to see what is committed and what is still
|
|
93
95
|
in the working tree, then continue from the **first unchecked step** instead of
|
|
94
|
-
|
|
96
|
+
### Step 0 - Mechanical Input Coverage Pre-flight Gate
|
|
97
|
+
|
|
98
|
+
Before touching code or executing build tasks, perform a positive **Input Coverage Test** against the active Living Spec:
|
|
99
|
+
- Enumerate every value, state, or data field this implementation must produce, compute, or display (from the acceptance criteria and spec design).
|
|
100
|
+
- For each required value, verify that the spec explicitly names where it comes from (e.g. database schema/column, API request parameter, calculated derivation from a named source, or explicit prior architectural decision).
|
|
101
|
+
- **Anti-Hallucination Guard**: Any required value with no named source is an **Owed Decision**. Do NOT rationalize it as "just wiring" and do NOT silently invent an ad-hoc provider, schema field, or business rule. Stop and route to `/grill` or request user clarification before proceeding.
|
|
95
102
|
|
|
96
103
|
## Step 1 - branch
|
|
97
104
|
|
|
98
|
-
Create
|
|
99
|
-
`fix/{xxx-slug}` for a fix, or `rollback/{xxx-slug}` for a Type: Rollback spec. If the
|
|
105
|
+
Create or select the branch for the spec using `git.featureBranchPrefix`, `git.fixBranchPrefix`, or `git.rollbackBranchPrefix` from config (defaults: `feature/`, `fix/`, `rollback/`). Preserve unrelated working-tree changes before switching. If the
|
|
100
106
|
project isn't a git repo yet, say so and ask the user to run `git init` first;
|
|
101
107
|
the loop needs branches. On resume, the branch already exists - check it out
|
|
102
108
|
instead of creating a new one.
|
|
@@ -105,99 +111,23 @@ instead of creating a new one.
|
|
|
105
111
|
|
|
106
112
|
When implementing a rollback task, follow the exact safety procedure in `reference/rollback-implementation.md`.
|
|
107
113
|
|
|
108
|
-
## Step 2 -
|
|
109
|
-
|
|
110
|
-
Work
|
|
111
|
-
|
|
112
|
-
1.
|
|
113
|
-
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
**Green-Phase Discipline**: Write the minimum code needed to pass the test; add only the options/features it requires (YAGNI constraint).
|
|
126
|
-
|
|
127
|
-
> 📖 For anti-patterns and Bad vs Good examples, read [`tdd-anti-patterns.md`](tdd-anti-patterns.md).
|
|
128
|
-
|
|
129
|
-
2. Implement just that step: the smallest change that satisfies its "done when."
|
|
130
|
-
3. Show the **diff**, not whole files.
|
|
131
|
-
4. **Explain it, and prove it.** Give a short summary: what the step delivered,
|
|
132
|
-
one line per changed file on what it does and why, then confirm the step's
|
|
133
|
-
"done when" is met with empirical evidence (test pass output, build output, or screenshot). This summary is the comprehension gate, so keep it concrete, not
|
|
134
|
-
vague. Include a short **How to try it** note when the step has a manual
|
|
135
|
-
path: the command, URL, click, endpoint, or output the user can check.
|
|
136
|
-
5. **Verify the step.** If `AGENTS.md` declares a `Verify` command, run that exact
|
|
137
|
-
command as the automated gate. It is only an umbrella for checks the project
|
|
138
|
-
actually has, so do not invent tests or other checks to satisfy it. If no
|
|
139
|
-
`Verify` command exists, run the documented build command and the test command
|
|
140
|
-
when the project declares one. A step that adds logic must ship a passing test
|
|
141
|
-
in the same diff when the test gate is on, and the suite must be green before
|
|
142
|
-
the step is approved (see the Testing gate in `coding-standards.md`). UI and
|
|
143
|
-
integration-only steps ride on screenshot plus build evidence. Run a focused
|
|
144
|
-
test separately when it gives faster feedback, then use `Verify` as the final
|
|
145
|
-
automated gate. For UI or integration done-whens, prefer Playwright when it is
|
|
146
|
-
already installed or declared in `AGENTS.md`; do not add it silently for an
|
|
147
|
-
unrelated feature. Create focused test files next to the source they cover,
|
|
148
|
-
per `coding-standards.md`. Never install a runner mid-step unless the current
|
|
149
|
-
spec is explicitly the unit-testing setup itself (for example `/fix "add unit
|
|
150
|
-
testing"`). If a step surfaces non-trivial logic the spec did not foresee, add
|
|
151
|
-
a focused test then, or note why not. When a step's done-when is behavioral (a
|
|
152
|
-
click, a download, or a flow across screens), run `/check` to prove it against
|
|
153
|
-
the running app rather than eyeballing it.
|
|
154
|
-
5. **Iterate until it works.** If it fails or the user wants changes, revise the
|
|
155
|
-
step (re-prompt or hand-edit the code), show the updated diff, and re-test.
|
|
156
|
-
Repeat until it works and the user approves. Nothing is committed until the
|
|
157
|
-
user is happy with the step.
|
|
158
|
-
6. **Mark it done, then prompt to move on.** Once the step is approved, check that
|
|
159
|
-
step off (`- [x]`) in `devflow/context/{xxx-slug}/spec.md` so progress survives a context
|
|
160
|
-
clear. If the step repaired a finding tracked in
|
|
161
|
-
`devflow/context/{xxx-slug}/findings.md`, set that finding's status to `fixed` now too
|
|
162
|
-
and note the repair in its **Resolution** line. Never set `closed`: a repair
|
|
163
|
-
is re-reviewed by `/audit` before it clears, because a fix can introduce a
|
|
164
|
-
worse defect than the one it removed. Then offer a short choice, noting that checkpoints are optional since
|
|
165
|
-
`/complete` makes the real feature-level commit. Use the current tool's short
|
|
166
|
-
user-input prompt when available; when you've just produced a long block to
|
|
167
|
-
read (a deep explanation, a big
|
|
168
|
-
walk-through), ask in plain text instead, so the prompt doesn't cover what the
|
|
169
|
-
user is still reading:
|
|
170
|
-
- **Continue** (default) - roll into the next step without committing.
|
|
171
|
-
- **Commit checkpoint** - commit just this step on the branch with a
|
|
172
|
-
conventional message (a cheap rollback point).
|
|
173
|
-
- **Walk me through it** - give a deeper, line-level explanation of the new or
|
|
174
|
-
changed code (why this approach, what each part does, any gotchas), then
|
|
175
|
-
re-ask this checkpoint prompt. A loop-back, not a terminal choice.
|
|
176
|
-
- **Stop here** - pause the loop so the user can review or come back later.
|
|
177
|
-
|
|
178
|
-
On **Continue** or after **Commit checkpoint**, go to the next step. On **Walk
|
|
179
|
-
me through it**, explain in depth and then re-ask this prompt in plain text (the
|
|
180
|
-
explanation is long, so a modal would cover it). On **Stop here**, stop and say
|
|
181
|
-
where things stand: the branch is intact; run `/implement` again to resume, or
|
|
182
|
-
`/complete` to wrap up what's built so far.
|
|
183
|
-
|
|
184
|
-
### Ticket-Driven TDD Execution (when working from a Ticket)
|
|
185
|
-
|
|
186
|
-
When executing a tracer-bullet ticket (via `--ticket` or auto-frontier):
|
|
187
|
-
1. **Extract Scope**: Read *What to build* and *Acceptance criteria* checklist (`- [ ]`) from the active ticket file.
|
|
188
|
-
2. **Strict TDD Cycle per Criterion**:
|
|
189
|
-
- **🔴 RED**: Write the unit/integration test for the criterion first at the agreed seam. Execute the test command and verify the expected failing assertion.
|
|
190
|
-
- **🟢 GREEN**: Implement only the minimal code in the source file necessary to make the test pass. Re-run test and show passing output.
|
|
191
|
-
- **🔵 REFACTOR**: Refactor and format cleanly, verifying that 100% of tests remain green.
|
|
192
|
-
3. **Verify Gate**: Run the project's Verify command (`npm run check` or documented test suite) to ensure whole-system health before concluding the ticket.
|
|
193
|
-
4. **Bidirectional State Sync**:
|
|
194
|
-
- Mark each completed criterion `- [x]` in the ticket file.
|
|
195
|
-
- Once all criteria in the ticket pass, update the ticket status to `**Status:** done` (or `Status: done`).
|
|
196
|
-
- Mirror the completed work, status, and diff evidence into `devflow/context/{xxx-slug}/spec.md` (under `## 📋 3. Execution Plan & TDD Checklist` and `## ⚡ 4. Implementation Log & Evidence`) so the Living Spec remains the authoritative single source of truth for `/check`, `/audit`, and `/complete`.
|
|
197
|
-
|
|
198
|
-
Never batch the whole thing into one diff. If a step's diff is too big to read,
|
|
199
|
-
split it. The documented `Verify` command, or the fallback build and tests, must
|
|
200
|
-
pass before any commit.
|
|
114
|
+
## Step 2 - implement and verify
|
|
115
|
+
|
|
116
|
+
Work in small reviewable diffs, keeping progress in the selected spec.
|
|
117
|
+
|
|
118
|
+
1. For logic or behavior changes with the test gate on, use Red-Green-Refactor: write a focused failing test, confirm the assertion fails for the missing behavior, implement the smallest change, then refactor with affected tests green. Preserve the user's existing work. Consult [TDD anti-patterns](tdd-anti-patterns.md) when test design needs it.
|
|
119
|
+
- **Proportional Engineering**: Add an abstraction, dependency, service, configuration surface, compatibility layer, or security mechanism only when the approved spec or an established repository requirement needs it now. Prefer existing code, standard library, and native platform features.
|
|
120
|
+
2. Match the step's done-when and run focused checks. Documentation or formatting-only edits use structural checks and review; they do not require artificial unit tests. Capture relevant runtime or browser proof for behavioral criteria, following the selected Check policy.
|
|
121
|
+
3. Fix failures caused by the change and rerun affected checks without requesting authorization again. Broaden verification when dependencies, failures, or risk justify it.
|
|
122
|
+
4. Record the diff summary and evidence. Mark a step complete once its done-when passes and any configured per-step review has been approved. A repaired finding becomes `fixed` with resolution evidence; only a subsequent audit can close it. Apply the review cadence above before proceeding.
|
|
123
|
+
|
|
124
|
+
Run a proportionality check before final verification: every new abstraction, dependency, service, configuration surface, compatibility layer, and security mechanism must trace to the approved spec or an established repository requirement. Remove speculative machinery this work added without weakening real trust-boundary validation, data-loss prevention, accessibility, or configured verification.
|
|
125
|
+
|
|
126
|
+
At the final handoff, run the exact documented Verify command and all required gates. If there is no Verify command, use the project's declared build and test commands. Reuse a passing result for unchanged inputs within this pass; rerun affected gates after subsequent edits. Do not add tests or tools just to inflate the verification matrix.
|
|
127
|
+
|
|
128
|
+
### Ticket execution
|
|
129
|
+
|
|
130
|
+
When a ticket is selected, use its acceptance criteria as the steps above. Mark completed criteria in the ticket, mark it `done` after its criteria and required verification pass, and mirror status and evidence into the run's spec. A ticket handoff runs required gates once; criteria within the ticket use focused checks. A request to finish the whole run continues through the dependency frontier until the authorized scope is verified.
|
|
201
131
|
|
|
202
132
|
After final Verify and required Check pass, set the active spec to `verified`
|
|
203
133
|
with every completed box checked. Then resolve independent review before the
|
|
@@ -270,23 +200,19 @@ named area. If the feature spans too many distinct areas for one useful pass,
|
|
|
270
200
|
name the sections first and let the user choose where to begin. Remain read-only
|
|
271
201
|
unless the user separately requests changes.
|
|
272
202
|
|
|
273
|
-
|
|
274
|
-
The sole exception is exactly one immutable independent-review checkpoint after
|
|
275
|
-
showing its exact candidate and receiving current explicit commit approval.
|
|
276
|
-
Configuration never supplies that approval. Never merge, push, deploy, publish,
|
|
203
|
+
Ordinary checkpoint commits are available only through the configured review boundary and explicit candidate approval above. The immutable independent-review checkpoint also requires explicit candidate approval. Work-level completion commits belong to `/complete`. Configuration never supplies commit approval. Never merge, push, deploy, publish,
|
|
277
204
|
or start unrelated work from this skill.
|
|
278
205
|
|
|
279
206
|
## Rules
|
|
280
207
|
|
|
281
|
-
-
|
|
208
|
+
- Keep diffs small and apply the configured review cadence.
|
|
282
209
|
- Explain every change in plain English. Understanding the code is the point.
|
|
283
210
|
- Iterate on the branch until each step works; never commit code the user hasn't
|
|
284
211
|
approved.
|
|
285
212
|
- Follow `devflow/context/coding-standards.md` (server vs client, scope user-owned queries
|
|
286
213
|
by the authenticated user id, validate inputs, and so on).
|
|
287
|
-
-
|
|
288
|
-
|
|
289
|
-
- Per-step commits are optional checkpoints. The work-level commit, the merge,
|
|
214
|
+
- Keep the spec aligned with the authorized scope. Correct routine omissions with evidence; ask only when a material scope or design decision is unresolved.
|
|
215
|
+
- Configured checkpoint offers are optional. The work-level commit, the merge,
|
|
290
216
|
and any push are `/complete`'s job.
|
|
291
217
|
- For Type: Rollback, reverse only the approved product diff and preserve all
|
|
292
218
|
protected Blueprint paths.
|
|
@@ -87,6 +87,32 @@ When generating or logging test runs during `/implement` or `/check`:
|
|
|
87
87
|
|
|
88
88
|
---
|
|
89
89
|
|
|
90
|
+
## 7. 5-Tier Test File Classification Strategy
|
|
91
|
+
|
|
92
|
+
Do not write identical test patterns for all file types. Classify files into 5 distinct tiers:
|
|
93
|
+
|
|
94
|
+
| Tier | Category / File Paths | Recommended Test Strategy | What NOT to do |
|
|
95
|
+
| :--- | :--- | :--- | :--- |
|
|
96
|
+
| 🧠 **Tier 1** | **Pure Logic & Algorithms**<br>`src/utils/`, `src/services/`, `lib/` | Fast in-memory Unit Tests with 100% boundary & edge cases coverage. Use TDD (Red-Green-Refactor). | Do not over-mock pure mathematical or transformation functions. |
|
|
97
|
+
| 🎨 **Tier 2** | **UI Components**<br>`src/components/`, `src/pages/` | Component rendering, event dispatching, visual verification via Playwright / BrowserOS Neo. | **Prohibited**: Do not write trivial unit tests that merely assert static HTML tags exist. |
|
|
98
|
+
| 🔌 **Tier 3** | **API & Data Integration**<br>`src/api/`, route handlers, DB models | Contract tests, schema validation (Zod), HTTP status codes, error payload shapes. | Do not test external third-party network APIs without isolated fakes. |
|
|
99
|
+
| ⚙️ **Tier 4** | **Config & Build Tooling**<br>`*.json`, `*.yaml`, `scripts/` | Static contract validation (`npm run check:static`), budget linters (`npm run check:budgets`), smoke tests. | Do not skip static validation on build tool modifications. |
|
|
100
|
+
| 📝 **Tier 5** | **Documentation & Prose**<br>`*.md`, `devflow/docs/` | Structural checks, markdown contract scans, and link integrity verification. | Do not write artificial unit test suites for documentation files. |
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## 8. Acceptance Criteria (`AC-N`) Traceability Protocol
|
|
105
|
+
|
|
106
|
+
To guarantee 100% spec fidelity, every automated test suite must trace back to the active Living Spec:
|
|
107
|
+
- **Test Title Tagging**: Prefix test titles or describe blocks with the target Acceptance Criterion:
|
|
108
|
+
```typescript
|
|
109
|
+
it('AC-1: enforces 32KB byte budget on SKILL.md files', async () => { ... });
|
|
110
|
+
it('AC-2: returns exit code 1 when budget violation occurs', async () => { ... });
|
|
111
|
+
```
|
|
112
|
+
- **Traceability Verification**: During `/check`, cross-reference every `- [ ] AC-N` against the passing test assertion name to ensure zero untracked requirements.
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
90
116
|
## Relationship To DevFlow 2.6.x
|
|
91
117
|
|
|
92
118
|
- **Classification**: Companion command & Engineering standard
|