@anhth2/spec-driven-dev-plugin 0.8.0 → 0.9.1
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/ARCHITECTURE.md +6 -2
- package/commands/debug.md +152 -0
- package/commands/debug.tmpl +16 -0
- package/commands/define-product.md +57 -0
- package/commands/fix-bug.md +153 -0
- package/commands/fix-bug.tmpl +17 -0
- package/commands/generate-bdd.md +277 -13
- package/commands/generate-bdd.tmpl +220 -13
- package/commands/generate-code.md +154 -2
- package/commands/generate-code.tmpl +97 -2
- package/commands/generate-design-spec.md +57 -0
- package/commands/generate-prd.md +114 -20
- package/commands/generate-prd.tmpl +57 -20
- package/commands/generate-spec-manifest.md +57 -0
- package/commands/generate-tech-docs.md +79 -1
- package/commands/generate-tech-docs.tmpl +22 -1
- package/commands/generate-tests.md +57 -0
- package/commands/learn.md +554 -0
- package/commands/learn.tmpl +63 -0
- package/commands/propose-scenario.md +521 -0
- package/commands/propose-scenario.tmpl +109 -0
- package/commands/refine-prd.md +66 -1
- package/commands/refine-prd.tmpl +9 -1
- package/commands/report-bug.md +543 -0
- package/commands/report-bug.tmpl +131 -0
- package/commands/review-code.md +153 -0
- package/commands/review-code.tmpl +17 -0
- package/commands/review-context.md +65 -0
- package/commands/review-context.tmpl +8 -0
- package/commands/review-tech-docs.md +146 -4
- package/commands/review-tech-docs.tmpl +89 -4
- package/commands/run-tests.md +82 -0
- package/commands/run-tests.tmpl +25 -0
- package/commands/setup-ai-first.md +15 -5
- package/commands/setup-ai-first.tmpl +10 -5
- package/commands/smoke-test.md +57 -0
- package/commands/sync.md +405 -0
- package/commands/sync.tmpl +345 -0
- package/commands/update-framework.md +211 -0
- package/commands/update-framework.tmpl +151 -0
- package/commands/validate-traces.md +115 -2
- package/commands/validate-traces.tmpl +58 -2
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +152 -0
- package/core/commands/define-product.md +57 -0
- package/core/commands/fix-bug.md +153 -0
- package/core/commands/generate-bdd.md +277 -13
- package/core/commands/generate-code.md +154 -2
- package/core/commands/generate-design-spec.md +57 -0
- package/core/commands/generate-prd.md +114 -20
- package/core/commands/generate-spec-manifest.md +57 -0
- package/core/commands/generate-tech-docs.md +79 -1
- package/core/commands/generate-tests.md +57 -0
- package/core/commands/learn.md +554 -0
- package/core/commands/propose-scenario.md +521 -0
- package/core/commands/refine-prd.md +66 -1
- package/core/commands/report-bug.md +543 -0
- package/core/commands/review-code.md +153 -0
- package/core/commands/review-context.md +65 -0
- package/core/commands/review-tech-docs.md +146 -4
- package/core/commands/run-tests.md +82 -0
- package/core/commands/setup-ai-first.md +15 -5
- package/core/commands/smoke-test.md +57 -0
- package/core/commands/sync.md +405 -0
- package/core/commands/update-framework.md +211 -0
- package/core/commands/validate-traces.md +115 -2
- package/core/skills/code/SKILL.md +62 -0
- package/core/skills/debug/SKILL.md +67 -0
- package/core/skills/design-spec/SKILL.md +57 -0
- package/core/skills/discovery/SKILL.md +57 -0
- package/core/skills/prd/SKILL.md +10 -0
- package/core/skills/setup-ai-first/SKILL.md +5 -0
- package/core/skills/spec/SKILL.md +10 -0
- package/core/skills/test/SKILL.md +119 -0
- package/core/steps/capture-lesson.md +79 -0
- package/core/steps/context-loader.md +52 -0
- package/core/steps/report-footer.md +5 -0
- package/core/templates/prd.template.md +35 -20
- package/core/templates/project-context.yaml +11 -0
- package/package.json +9 -2
- package/skills/code/SKILL.md +62 -0
- package/skills/debug/SKILL.md +67 -0
- package/skills/design-spec/SKILL.md +57 -0
- package/skills/discovery/SKILL.md +57 -0
- package/skills/prd/SKILL.md +10 -0
- package/skills/setup-ai-first/SKILL.md +5 -0
- package/skills/spec/SKILL.md +10 -0
- package/skills/test/SKILL.md +119 -0
- package/steps/capture-lesson.md +79 -0
- package/steps/context-loader.md +52 -0
- package/steps/report-footer.md +5 -0
- package/templates/prd.template.md +35 -20
- package/templates/project-context.yaml +11 -0
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# /report-bug — File a Spec-Traced Bug (Tester-Facing)
|
|
2
|
+
|
|
3
|
+
For **testers**. Produces a structured bug report with full spec context, classifies the likely
|
|
4
|
+
layer, and saves it for handoff to the dev team.
|
|
5
|
+
|
|
6
|
+
**READ-ONLY on specs and code.** This command never edits PRD, BDD, tech-docs, or source.
|
|
7
|
+
Fixing is the dev's job (`/fix-bug`); writing scenarios is `/propose-scenario`.
|
|
8
|
+
|
|
9
|
+
Usage: `/report-bug {UC-ID or TICKET} {short description}`
|
|
10
|
+
Example: `/report-bug FT-001 account locks after 6 failed logins, spec says 5`
|
|
11
|
+
|
|
12
|
+
## Gate
|
|
13
|
+
{{include:steps/gate.md}}
|
|
14
|
+
|
|
15
|
+
*Note: For this command, the target in Step 1 is a UC-ID / TICKET from `$ARGUMENTS`. Resolve the matching `.feature` file if one exists; if not, continue — a bug can still be filed.*
|
|
16
|
+
|
|
17
|
+
## Context
|
|
18
|
+
{{include:steps/context-loader.md}}
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Step 1 — Resolve Spec Context
|
|
23
|
+
|
|
24
|
+
Locate the spec chain for the bug's UC/TICKET. Prefer `spec-manifest.yaml` (umbrella/tester setup) if present; else use resolved `paths`.
|
|
25
|
+
|
|
26
|
+
Gather and store:
|
|
27
|
+
- `prd_path` + current PRD `Version`
|
|
28
|
+
- `bdd_path` (the `.feature` for this UC) + the specific **failing scenario** title, if one matches
|
|
29
|
+
- `tech_doc_path` (if any)
|
|
30
|
+
- `service` / domain
|
|
31
|
+
|
|
32
|
+
If no `.feature` scenario matches the reported behavior → set `coverage_gap = true` (the behavior is untested by BDD).
|
|
33
|
+
|
|
34
|
+
## Step 2 — Gather Bug Details
|
|
35
|
+
|
|
36
|
+
If not already in `$ARGUMENTS`, ask the tester (one compact prompt):
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
File a bug — answer what you can:
|
|
40
|
+
1. Where does it occur? (endpoint / screen / flow)
|
|
41
|
+
2. Steps to reproduce?
|
|
42
|
+
3. Expected (per spec) vs Actual?
|
|
43
|
+
4. Error / log / status code?
|
|
44
|
+
5. Environment? (staging / prod / local)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Step 3 — Identify the AC Violated
|
|
48
|
+
|
|
49
|
+
Read the PRD acceptance criteria for this UC. Match the bug to the specific **AC** it violates
|
|
50
|
+
(e.g. `AC3: "5 failed logins → lock 30m"`). Quote it verbatim. If the behavior maps to no AC →
|
|
51
|
+
note "No AC covers this" and treat as a possible PRD gap.
|
|
52
|
+
|
|
53
|
+
## Step 4 — Classify Likely Layer (BUG_FLOW)
|
|
54
|
+
|
|
55
|
+
Apply the BUG_FLOW decision table to suggest where the root cause likely is — this routes the bug:
|
|
56
|
+
|
|
57
|
+
| If… | Likely layer | Route to |
|
|
58
|
+
|------|-------------|----------|
|
|
59
|
+
| Code contradicts a BDD scenario | **Code bug** (Case 1) | Dev → `/fix-bug` |
|
|
60
|
+
| BDD scenario contradicts PRD AC | **BDD bug** (Case 2) | Dev/PO fix BDD |
|
|
61
|
+
| PRD AC is ambiguous / silent | **PRD ambiguity** (Case 3) | PO clarifies PRD |
|
|
62
|
+
| Behavior correct but **no scenario covers it** | **BDD coverage gap** | Tester → `/propose-scenario` |
|
|
63
|
+
| UI ≠ Design Spec | **Design Spec bug** (Case 5) | Dev/Designer |
|
|
64
|
+
| Env / data only | **Environment** (Case 6) | DevOps |
|
|
65
|
+
|
|
66
|
+
State the classification as a suggestion (dev confirms during `/fix-bug`).
|
|
67
|
+
|
|
68
|
+
## Step 5 — Write the Report
|
|
69
|
+
|
|
70
|
+
Assign `BUG-{today YYYYMMDD}-{NN}` (NN = next sequence among existing reports).
|
|
71
|
+
Write to `{paths.bug_reports_dir}/{BUG-ID}.md` (resolved to `{spec_source}/feedback/bug-reports/` in umbrella mode; create dir if needed) using the structure in the Output block, and also print it for pasting into Jira/Slack.
|
|
72
|
+
|
|
73
|
+
## Step 6 — Handoff (so PO/Dev actually see it)
|
|
74
|
+
|
|
75
|
+
The report only reaches PO/Dev if it is **committed and pushed to the shared spec repo**. A local file is a dead drop.
|
|
76
|
+
|
|
77
|
+
Determine the repo that owns `{paths.bug_reports_dir}`:
|
|
78
|
+
- Umbrella mode → the spec submodule at `{spec_source}`
|
|
79
|
+
- Single-service → the current repo
|
|
80
|
+
|
|
81
|
+
Then commit + push **that** repo:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
cd {spec_source} # umbrella: the spec submodule; single-service: omit
|
|
85
|
+
git add feedback/bug-reports/{BUG-ID}.md
|
|
86
|
+
git commit -m "qa(bug): {BUG-ID} — {short description}"
|
|
87
|
+
git push # → PO/Dev see it on their next /sync
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
- If the tester lacks push rights to the spec repo → open a PR / MR instead, or hand the file to whoever owns it. Print this fallback.
|
|
91
|
+
- Print the exact commands if you do not run them automatically.
|
|
92
|
+
|
|
93
|
+
> PO/Dev are notified through their normal routine: `/sync` lists newly-pulled bug reports.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## Output
|
|
98
|
+
|
|
99
|
+
{{include:steps/report-footer.md}}
|
|
100
|
+
|
|
101
|
+
```
|
|
102
|
+
🐞 {BUG-ID} → {paths.bug_reports_dir}/{BUG-ID}.md (in shared spec repo)
|
|
103
|
+
|
|
104
|
+
Feature : {UC-ID} — {feature name} | Service: {service} | Severity: {Critical|Major|Minor}
|
|
105
|
+
|
|
106
|
+
Spec context
|
|
107
|
+
PRD : {prd_path} (v{prd_version})
|
|
108
|
+
BDD : {bdd_path} → Scenario: "{scenario title}" {or: ⚠️ no scenario covers this}
|
|
109
|
+
Tech Doc : {tech_doc_path}
|
|
110
|
+
|
|
111
|
+
AC violated
|
|
112
|
+
{AC-N}: "{AC text}"
|
|
113
|
+
|
|
114
|
+
Expected (per spec) : {expected}
|
|
115
|
+
Actual : {actual}
|
|
116
|
+
Steps to reproduce : {1..N}
|
|
117
|
+
Environment : {env}
|
|
118
|
+
|
|
119
|
+
Likely layer : {Code | BDD | PRD | Design Spec | Env} → {route}
|
|
120
|
+
|
|
121
|
+
Handoff : {✅ committed + pushed to spec repo | ⚠️ run the git commands above / open a PR}
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
Status : ✅ Complete (read-only on specs/code — only wrote the feedback file)
|
|
125
|
+
Output Artifacts: created {paths.bug_reports_dir}/{BUG-ID}.md (pushed to shared spec repo)
|
|
126
|
+
Next :
|
|
127
|
+
- PO/Dev will see this on their next /sync
|
|
128
|
+
- Code bug → dev runs /fix-bug {BUG-ID}
|
|
129
|
+
- PRD ambiguity → PO (BUG_FLOW Case 3)
|
|
130
|
+
- Coverage gap → /propose-scenario {UC-ID}
|
|
131
|
+
```
|
package/commands/review-code.md
CHANGED
|
@@ -180,6 +180,37 @@ If `services` section is present:
|
|
|
180
180
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
181
181
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
182
182
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
183
|
+
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
184
|
+
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
185
|
+
|
|
186
|
+
> **Why under `spec_source`:** tester feedback (`/report-bug`, `/propose-scenario`) must land in the **shared spec repo** so PO/Dev see it when they `/sync`. In single-service mode (no `spec_source`), these default to `feedback/bug-reports` and `feedback/bdd-proposals` at repo root — still shared, same repo.
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## Step 1.6 — [SERVICE CONVENTIONS] Load service-specific conventions (umbrella mode)
|
|
191
|
+
|
|
192
|
+
*Skip this step entirely if `active_service` is `"unresolved"` or context is single-service mode.*
|
|
193
|
+
|
|
194
|
+
When `active_service` has been resolved to a real path in Step 1.5 (e.g., `user-service/`):
|
|
195
|
+
|
|
196
|
+
**1. Locate service config** — try in priority order:
|
|
197
|
+
- `{active_service}/.agent/project-context.yaml`
|
|
198
|
+
- `{active_service}/project-context.yaml`
|
|
199
|
+
|
|
200
|
+
**2. If found, override with service-specific values:**
|
|
201
|
+
|
|
202
|
+
| Variable | Source |
|
|
203
|
+
|----------|--------|
|
|
204
|
+
| `conventions.test_command` | service's `conventions.test_command` |
|
|
205
|
+
| `conventions.build_command` | service's `conventions.build_command` |
|
|
206
|
+
| `paths.trace_dir` | `{active_service}/{service paths.trace_dir}` — default: `{active_service}/.trace` |
|
|
207
|
+
| `paths.specs_dir` | `{active_service}/{service paths.specs_dir}` (if set in service config, else keep Step 1.5 override) |
|
|
208
|
+
|
|
209
|
+
**3. Store** `service_root = {active_service}` as the working directory anchor for all downstream commands:
|
|
210
|
+
- Shell commands (`/run-tests`, `/generate-tests`) run **from within** `service_root`
|
|
211
|
+
- File write operations (test files, trace TSVs) use paths **relative to** `service_root`
|
|
212
|
+
|
|
213
|
+
**4. If service config not found** — keep umbrella defaults, still set `service_root = {active_service}` (path anchor is always needed even without a config override).
|
|
183
214
|
|
|
184
215
|
---
|
|
185
216
|
|
|
@@ -273,6 +304,25 @@ These two variables (`active_module`, `platform_type`) are the canonical source
|
|
|
273
304
|
|
|
274
305
|
---
|
|
275
306
|
|
|
307
|
+
## Step 6.7 — [GUARDRAILS] Load Project Lessons (conditional)
|
|
308
|
+
|
|
309
|
+
*Accumulated mistakes the AI must not repeat in this project. These are added over time via `/learn`
|
|
310
|
+
or accepted during `/review-code`, `/fix-bug`, `/debug`.*
|
|
311
|
+
|
|
312
|
+
Resolve the lessons file path:
|
|
313
|
+
- Use `paths.lessons_file` if set (may be service-overridden in umbrella mode, Step 1.6)
|
|
314
|
+
- Else default `specs/domain-knowledge/lessons-learned.md`
|
|
315
|
+
- In umbrella/service mode (when `service_root` is set), if `paths.lessons_file` is unset, default to `{service_root}/.agent/project-lessons.md`
|
|
316
|
+
|
|
317
|
+
If the file exists, read it and store ALL lessons as **ACTIVE GUARDRAILS** for the session:
|
|
318
|
+
- Treat each lesson's **Rule** as a hard constraint — same priority as CLAUDE.md coding standards (Step 3).
|
|
319
|
+
- Before generating or modifying any artifact (PRD, BDD, tech-doc, code, test), check the output against every lesson whose `category` matches the current command AND whose `scope` matches the target (domain / file).
|
|
320
|
+
- If a generated output would violate a lesson → correct it **before** presenting, and note which lesson (`L-NNN`) was applied.
|
|
321
|
+
|
|
322
|
+
If the file does not exist → skip silently (no lessons captured yet).
|
|
323
|
+
|
|
324
|
+
---
|
|
325
|
+
|
|
276
326
|
## Step 7 — [RECAP] Working Memory Recap (anti-lost-in-middle)
|
|
277
327
|
|
|
278
328
|
After loading all context, synthesize and output a compact summary block.
|
|
@@ -288,7 +338,9 @@ Layers : {layer order from CLAUDE.md §2, e.g., Controller → Facade → Ser
|
|
|
288
338
|
Ticket : {ticket_prefix}-
|
|
289
339
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
290
340
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
341
|
+
Lessons : {loaded — N guardrails | none yet}
|
|
291
342
|
Service : {active_service} ({active_service_module}) | single-service
|
|
343
|
+
Svc Root : {service_root} — conventions + trace_dir loaded from service config | —
|
|
292
344
|
Status : {FULL | PARTIAL — missing: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
293
345
|
```
|
|
294
346
|
|
|
@@ -405,6 +457,11 @@ Suggest the logical next command based on workflow phase:
|
|
|
405
457
|
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/generate-tests {UC-ID}`; all OK → create PR |
|
|
406
458
|
| /fix-bug | Create PR and link to ticket |
|
|
407
459
|
| /debug | `/fix-bug {ticket-id}` if fix needed |
|
|
460
|
+
| /report-bug | Send to dev (`/fix-bug {BUG-ID}`); if coverage gap → `/propose-scenario {UC-ID}` |
|
|
461
|
+
| /propose-scenario | Notify PO/Dev to review the proposal in `feedback/bdd-proposals/` |
|
|
462
|
+
| /learn | Continue working — lesson applies on next command |
|
|
463
|
+
| /sync | `/validate-traces` for full coverage; act on any `📥 tester feedback` surfaced |
|
|
464
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` for project content |
|
|
408
465
|
|
|
409
466
|
Format the footer as:
|
|
410
467
|
```
|
|
@@ -440,3 +497,99 @@ If NEEDS_FIX ❌:
|
|
|
440
497
|
- Logic / architecture issue → /fix-bug {TICKET_ID}
|
|
441
498
|
- Spec mismatch (code ≠ scenario) → /generate-code {feature-file} (re-gen affected UC)
|
|
442
499
|
```
|
|
500
|
+
|
|
501
|
+
---
|
|
502
|
+
|
|
503
|
+
## Offer to Record Lessons (optional)
|
|
504
|
+
|
|
505
|
+
For each **Critical/Major** finding that represents a **repeatable AI mistake** during code generation
|
|
506
|
+
(an architecture/standards violation the AI is likely to make again — NOT a one-off typo or an external cause), ask:
|
|
507
|
+
|
|
508
|
+
```
|
|
509
|
+
Finding "{issue}" looks like a repeatable mistake.
|
|
510
|
+
Record it as a project lesson so /generate-code won't repeat it? (Y/N)
|
|
511
|
+
```
|
|
512
|
+
|
|
513
|
+
If `Y` → run the capture procedure below with `category=code-gen`, `source=/review-code {UC-ID}`,
|
|
514
|
+
`scope` = the affected domain or file glob.
|
|
515
|
+
|
|
516
|
+
# Capture Lesson — Record a Recurring Mistake as a Guardrail
|
|
517
|
+
|
|
518
|
+
Reusable procedure to persist a "lesson" so the AI does not repeat a mistake in this project.
|
|
519
|
+
Used by `/learn` (manual) and offered by `/review-code`, `/fix-bug`, `/debug` (auto).
|
|
520
|
+
|
|
521
|
+
> **Project memory, not model training.** A lesson is plain text injected into context at the
|
|
522
|
+
> start of every command (context-loader Step 6.7). Functionally this stops the repeat — the AI
|
|
523
|
+
> sees the guardrail before it generates. No model weights change.
|
|
524
|
+
|
|
525
|
+
## L1 — Resolve the lessons file
|
|
526
|
+
|
|
527
|
+
Resolve `lessons_path` in this order:
|
|
528
|
+
1. `paths.lessons_file` from loaded context (may be service-overridden in umbrella mode, Step 1.6)
|
|
529
|
+
2. Default `specs/domain-knowledge/lessons-learned.md` (single-service)
|
|
530
|
+
3. In umbrella/service mode (when `service_root` is set) default `{service_root}/.agent/project-lessons.md`
|
|
531
|
+
|
|
532
|
+
## L2 — Build the lesson
|
|
533
|
+
|
|
534
|
+
Gather these fields — from `$ARGUMENTS` (for `/learn`) or from the calling command's findings
|
|
535
|
+
(for `/review-code`, `/fix-bug`, `/debug`):
|
|
536
|
+
|
|
537
|
+
| Field | Meaning |
|
|
538
|
+
|-------|---------|
|
|
539
|
+
| `category` | one of: `code-gen` \| `bdd` \| `tech-docs` \| `tests` \| `prd` \| `general` |
|
|
540
|
+
| `title` | short phrase naming the mistake |
|
|
541
|
+
| `mistake` | concretely, what the AI did wrong |
|
|
542
|
+
| `rule` | imperative correction — "Always …" / "Never …" — testable, not vague |
|
|
543
|
+
| `scope` | where it applies: a domain, a file glob (e.g. `*Controller.*`), or `all` |
|
|
544
|
+
| `source` | how captured: `/learn` \| `/review-code {UC-ID}` \| `/fix-bug {TICKET}` \| `/debug` |
|
|
545
|
+
|
|
546
|
+
If `rule` is vague (e.g. "be careful"), rewrite it into a concrete, checkable instruction before saving.
|
|
547
|
+
|
|
548
|
+
## L3 — De-duplicate
|
|
549
|
+
|
|
550
|
+
Read existing lessons in `lessons_path`. If one already covers the same mistake:
|
|
551
|
+
- **Refine** that entry (tighten the Rule, widen/narrow Scope, bump Date, append the new Source) — do NOT add a duplicate.
|
|
552
|
+
|
|
553
|
+
Otherwise assign the next id `L-{NNN}` = (highest existing number + 1), zero-padded to 3 digits.
|
|
554
|
+
|
|
555
|
+
## L4 — Write
|
|
556
|
+
|
|
557
|
+
If `lessons_path` does not exist, create it with this header first:
|
|
558
|
+
|
|
559
|
+
```markdown
|
|
560
|
+
# Project Lessons — Learned Guardrails
|
|
561
|
+
|
|
562
|
+
> Mistakes the AI must NOT repeat in this project. Loaded by context-loader at the start of
|
|
563
|
+
> every command and treated as hard constraints (same priority as CLAUDE.md coding standards).
|
|
564
|
+
> Add with /learn, or accept the prompt during /review-code, /fix-bug, /debug.
|
|
565
|
+
> Commit this file so the whole team shares the guardrails.
|
|
566
|
+
|
|
567
|
+
| Category | Applies to |
|
|
568
|
+
|----------|-----------|
|
|
569
|
+
| code-gen | /generate-code output |
|
|
570
|
+
| bdd | /generate-bdd output |
|
|
571
|
+
| tech-docs | /generate-tech-docs output |
|
|
572
|
+
| tests | /generate-tests output |
|
|
573
|
+
| prd | /generate-prd, /refine-prd output |
|
|
574
|
+
| general | every command |
|
|
575
|
+
|
|
576
|
+
---
|
|
577
|
+
```
|
|
578
|
+
|
|
579
|
+
Insert the new lesson directly under the `---` separator (**newest first**), in this exact shape:
|
|
580
|
+
|
|
581
|
+
```markdown
|
|
582
|
+
### L-{NNN} — [{category}] {title}
|
|
583
|
+
- **Date**: {today YYYY-MM-DD}
|
|
584
|
+
- **Scope**: {scope}
|
|
585
|
+
- **Mistake**: {mistake}
|
|
586
|
+
- **Rule**: {rule}
|
|
587
|
+
- **Source**: {source}
|
|
588
|
+
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
## L5 — Confirm
|
|
592
|
+
|
|
593
|
+
Print: `📝 Lesson {id} recorded → {lessons_path} ([{category}] {title})`
|
|
594
|
+
Then remind: `Commit {lessons_path} so the team shares this guardrail.`
|
|
595
|
+
|
|
@@ -85,3 +85,20 @@ If NEEDS_FIX ❌:
|
|
|
85
85
|
- Logic / architecture issue → /fix-bug {TICKET_ID}
|
|
86
86
|
- Spec mismatch (code ≠ scenario) → /generate-code {feature-file} (re-gen affected UC)
|
|
87
87
|
```
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## Offer to Record Lessons (optional)
|
|
92
|
+
|
|
93
|
+
For each **Critical/Major** finding that represents a **repeatable AI mistake** during code generation
|
|
94
|
+
(an architecture/standards violation the AI is likely to make again — NOT a one-off typo or an external cause), ask:
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
Finding "{issue}" looks like a repeatable mistake.
|
|
98
|
+
Record it as a project lesson so /generate-code won't repeat it? (Y/N)
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
If `Y` → run the capture procedure below with `category=code-gen`, `source=/review-code {UC-ID}`,
|
|
102
|
+
`scope` = the affected domain or file glob.
|
|
103
|
+
|
|
104
|
+
{{include:steps/capture-lesson.md}}
|
|
@@ -185,6 +185,37 @@ If `services` section is present:
|
|
|
185
185
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
186
186
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
187
187
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
188
|
+
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
189
|
+
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
190
|
+
|
|
191
|
+
> **Why under `spec_source`:** tester feedback (`/report-bug`, `/propose-scenario`) must land in the **shared spec repo** so PO/Dev see it when they `/sync`. In single-service mode (no `spec_source`), these default to `feedback/bug-reports` and `feedback/bdd-proposals` at repo root — still shared, same repo.
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
## Step 1.6 — [SERVICE CONVENTIONS] Load service-specific conventions (umbrella mode)
|
|
196
|
+
|
|
197
|
+
*Skip this step entirely if `active_service` is `"unresolved"` or context is single-service mode.*
|
|
198
|
+
|
|
199
|
+
When `active_service` has been resolved to a real path in Step 1.5 (e.g., `user-service/`):
|
|
200
|
+
|
|
201
|
+
**1. Locate service config** — try in priority order:
|
|
202
|
+
- `{active_service}/.agent/project-context.yaml`
|
|
203
|
+
- `{active_service}/project-context.yaml`
|
|
204
|
+
|
|
205
|
+
**2. If found, override with service-specific values:**
|
|
206
|
+
|
|
207
|
+
| Variable | Source |
|
|
208
|
+
|----------|--------|
|
|
209
|
+
| `conventions.test_command` | service's `conventions.test_command` |
|
|
210
|
+
| `conventions.build_command` | service's `conventions.build_command` |
|
|
211
|
+
| `paths.trace_dir` | `{active_service}/{service paths.trace_dir}` — default: `{active_service}/.trace` |
|
|
212
|
+
| `paths.specs_dir` | `{active_service}/{service paths.specs_dir}` (if set in service config, else keep Step 1.5 override) |
|
|
213
|
+
|
|
214
|
+
**3. Store** `service_root = {active_service}` as the working directory anchor for all downstream commands:
|
|
215
|
+
- Shell commands (`/run-tests`, `/generate-tests`) run **from within** `service_root`
|
|
216
|
+
- File write operations (test files, trace TSVs) use paths **relative to** `service_root`
|
|
217
|
+
|
|
218
|
+
**4. If service config not found** — keep umbrella defaults, still set `service_root = {active_service}` (path anchor is always needed even without a config override).
|
|
188
219
|
|
|
189
220
|
---
|
|
190
221
|
|
|
@@ -278,6 +309,25 @@ These two variables (`active_module`, `platform_type`) are the canonical source
|
|
|
278
309
|
|
|
279
310
|
---
|
|
280
311
|
|
|
312
|
+
## Step 6.7 — [GUARDRAILS] Load Project Lessons (conditional)
|
|
313
|
+
|
|
314
|
+
*Accumulated mistakes the AI must not repeat in this project. These are added over time via `/learn`
|
|
315
|
+
or accepted during `/review-code`, `/fix-bug`, `/debug`.*
|
|
316
|
+
|
|
317
|
+
Resolve the lessons file path:
|
|
318
|
+
- Use `paths.lessons_file` if set (may be service-overridden in umbrella mode, Step 1.6)
|
|
319
|
+
- Else default `specs/domain-knowledge/lessons-learned.md`
|
|
320
|
+
- In umbrella/service mode (when `service_root` is set), if `paths.lessons_file` is unset, default to `{service_root}/.agent/project-lessons.md`
|
|
321
|
+
|
|
322
|
+
If the file exists, read it and store ALL lessons as **ACTIVE GUARDRAILS** for the session:
|
|
323
|
+
- Treat each lesson's **Rule** as a hard constraint — same priority as CLAUDE.md coding standards (Step 3).
|
|
324
|
+
- Before generating or modifying any artifact (PRD, BDD, tech-doc, code, test), check the output against every lesson whose `category` matches the current command AND whose `scope` matches the target (domain / file).
|
|
325
|
+
- If a generated output would violate a lesson → correct it **before** presenting, and note which lesson (`L-NNN`) was applied.
|
|
326
|
+
|
|
327
|
+
If the file does not exist → skip silently (no lessons captured yet).
|
|
328
|
+
|
|
329
|
+
---
|
|
330
|
+
|
|
281
331
|
## Step 7 — [RECAP] Working Memory Recap (anti-lost-in-middle)
|
|
282
332
|
|
|
283
333
|
After loading all context, synthesize and output a compact summary block.
|
|
@@ -293,7 +343,9 @@ Layers : {layer order from CLAUDE.md §2, e.g., Controller → Facade → Ser
|
|
|
293
343
|
Ticket : {ticket_prefix}-
|
|
294
344
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
295
345
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
346
|
+
Lessons : {loaded — N guardrails | none yet}
|
|
296
347
|
Service : {active_service} ({active_service_module}) | single-service
|
|
348
|
+
Svc Root : {service_root} — conventions + trace_dir loaded from service config | —
|
|
297
349
|
Status : {FULL | PARTIAL — missing: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
298
350
|
```
|
|
299
351
|
|
|
@@ -511,6 +563,8 @@ findings:
|
|
|
511
563
|
check_id: "P1" # P1-P5 for PRD; B1-B6 for BDD
|
|
512
564
|
severity: "critical" # critical | major | minor
|
|
513
565
|
section: "{section or scenario ID where issue was found}"
|
|
566
|
+
uc_id: "{UC-ID this finding belongs to — PRD: the UC heading; BDD: @trace.id; \"\" if global}"
|
|
567
|
+
quote: "{verbatim snippet copied EXACTLY from the reviewed file at the issue location, ≤120 chars}"
|
|
514
568
|
finding: "{clear description of the issue}"
|
|
515
569
|
suggestion: "{specific actionable fix — AI will apply this in --resume if accepted}"
|
|
516
570
|
auto_fixable: true # true = AI can apply; false = human must write note in Review Board
|
|
@@ -524,6 +578,12 @@ summary:
|
|
|
524
578
|
recommendation: "APPROVED | NEEDS_REVISION | BLOCKED"
|
|
525
579
|
```
|
|
526
580
|
|
|
581
|
+
> **Locator fields (`quote` + `uc_id`) — required for Review Board source-jump.**
|
|
582
|
+
> For every finding, copy a short **verbatim** `quote` straight from the reviewed file at the exact
|
|
583
|
+
> spot the issue occurs — do NOT paraphrase; it is matched against the document to locate the line.
|
|
584
|
+
> Set `uc_id` to the owning Use Case (`@trace.id` for BDD, the UC heading for PRD; `""` if global).
|
|
585
|
+
> These let a reviewer click a finding in the Review Board and jump to the precise source location.
|
|
586
|
+
|
|
527
587
|
## Post-Analysis Routing
|
|
528
588
|
|
|
529
589
|
After running all checks and writing the findings file:
|
|
@@ -581,6 +641,11 @@ Suggest the logical next command based on workflow phase:
|
|
|
581
641
|
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/generate-tests {UC-ID}`; all OK → create PR |
|
|
582
642
|
| /fix-bug | Create PR and link to ticket |
|
|
583
643
|
| /debug | `/fix-bug {ticket-id}` if fix needed |
|
|
644
|
+
| /report-bug | Send to dev (`/fix-bug {BUG-ID}`); if coverage gap → `/propose-scenario {UC-ID}` |
|
|
645
|
+
| /propose-scenario | Notify PO/Dev to review the proposal in `feedback/bdd-proposals/` |
|
|
646
|
+
| /learn | Continue working — lesson applies on next command |
|
|
647
|
+
| /sync | `/validate-traces` for full coverage; act on any `📥 tester feedback` surfaced |
|
|
648
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` for project content |
|
|
584
649
|
|
|
585
650
|
Format the footer as:
|
|
586
651
|
```
|
|
@@ -211,6 +211,8 @@ findings:
|
|
|
211
211
|
check_id: "P1" # P1-P5 for PRD; B1-B6 for BDD
|
|
212
212
|
severity: "critical" # critical | major | minor
|
|
213
213
|
section: "{section or scenario ID where issue was found}"
|
|
214
|
+
uc_id: "{UC-ID this finding belongs to — PRD: the UC heading; BDD: @trace.id; \"\" if global}"
|
|
215
|
+
quote: "{verbatim snippet copied EXACTLY from the reviewed file at the issue location, ≤120 chars}"
|
|
214
216
|
finding: "{clear description of the issue}"
|
|
215
217
|
suggestion: "{specific actionable fix — AI will apply this in --resume if accepted}"
|
|
216
218
|
auto_fixable: true # true = AI can apply; false = human must write note in Review Board
|
|
@@ -224,6 +226,12 @@ summary:
|
|
|
224
226
|
recommendation: "APPROVED | NEEDS_REVISION | BLOCKED"
|
|
225
227
|
```
|
|
226
228
|
|
|
229
|
+
> **Locator fields (`quote` + `uc_id`) — required for Review Board source-jump.**
|
|
230
|
+
> For every finding, copy a short **verbatim** `quote` straight from the reviewed file at the exact
|
|
231
|
+
> spot the issue occurs — do NOT paraphrase; it is matched against the document to locate the line.
|
|
232
|
+
> Set `uc_id` to the owning Use Case (`@trace.id` for BDD, the UC heading for PRD; `""` if global).
|
|
233
|
+
> These let a reviewer click a finding in the Review Board and jump to the precise source location.
|
|
234
|
+
|
|
227
235
|
## Post-Analysis Routing
|
|
228
236
|
|
|
229
237
|
After running all checks and writing the findings file:
|