ai-engineering-kit 0.1.0 → 0.3.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.
Files changed (49) hide show
  1. package/README.md +3 -1
  2. package/dist/cli.js +71 -27
  3. package/package.json +1 -1
  4. package/template/skills/core-workflow/commit-organizer/SKILL.md +174 -0
  5. package/template/skills/engineering/diagnose/SKILL.md +117 -0
  6. package/template/skills/engineering/diagnose/scripts/hitl-loop.template.sh +41 -0
  7. package/template/skills/engineering/grill-with-docs/ADR-FORMAT.md +47 -0
  8. package/template/skills/engineering/grill-with-docs/CONTEXT-FORMAT.md +60 -0
  9. package/template/skills/engineering/grill-with-docs/SKILL.md +88 -0
  10. package/template/skills/engineering/improve-codebase-architecture/DEEPENING.md +37 -0
  11. package/template/skills/engineering/improve-codebase-architecture/HTML-REPORT.md +123 -0
  12. package/template/skills/engineering/improve-codebase-architecture/INTERFACE-DESIGN.md +44 -0
  13. package/template/skills/engineering/improve-codebase-architecture/LANGUAGE.md +53 -0
  14. package/template/skills/engineering/improve-codebase-architecture/SKILL.md +81 -0
  15. package/template/skills/engineering/prototype/LOGIC.md +79 -0
  16. package/template/skills/engineering/prototype/SKILL.md +30 -0
  17. package/template/skills/engineering/prototype/UI.md +112 -0
  18. package/template/skills/engineering/setup-matt-pocock-skills/SKILL.md +121 -0
  19. package/template/skills/engineering/setup-matt-pocock-skills/domain.md +51 -0
  20. package/template/skills/engineering/setup-matt-pocock-skills/issue-tracker-github.md +22 -0
  21. package/template/skills/engineering/setup-matt-pocock-skills/issue-tracker-gitlab.md +23 -0
  22. package/template/skills/engineering/setup-matt-pocock-skills/issue-tracker-local.md +19 -0
  23. package/template/skills/engineering/setup-matt-pocock-skills/triage-labels.md +15 -0
  24. package/template/skills/engineering/tdd/SKILL.md +109 -0
  25. package/template/skills/engineering/tdd/deep-modules.md +33 -0
  26. package/template/skills/engineering/tdd/interface-design.md +31 -0
  27. package/template/skills/engineering/tdd/mocking.md +59 -0
  28. package/template/skills/engineering/tdd/refactoring.md +10 -0
  29. package/template/skills/engineering/tdd/tests.md +61 -0
  30. package/template/skills/engineering/to-issues/SKILL.md +83 -0
  31. package/template/skills/engineering/to-prd/SKILL.md +74 -0
  32. package/template/skills/engineering/triage/AGENT-BRIEF.md +168 -0
  33. package/template/skills/engineering/triage/OUT-OF-SCOPE.md +101 -0
  34. package/template/skills/engineering/triage/SKILL.md +103 -0
  35. package/template/skills/engineering/zoom-out/SKILL.md +7 -0
  36. package/template/skills/misc/git-guardrails-claude-code/SKILL.md +95 -0
  37. package/template/skills/misc/git-guardrails-claude-code/scripts/block-dangerous-git.sh +25 -0
  38. package/template/skills/misc/migrate-to-shoehorn/SKILL.md +118 -0
  39. package/template/skills/misc/scaffold-exercises/SKILL.md +106 -0
  40. package/template/skills/misc/setup-pre-commit/SKILL.md +91 -0
  41. package/template/skills/productivity/caveman/SKILL.md +49 -0
  42. package/template/skills/productivity/grill-me/SKILL.md +10 -0
  43. package/template/skills/productivity/handoff/SKILL.md +15 -0
  44. package/template/skills/productivity/teach/GLOSSARY-FORMAT.md +35 -0
  45. package/template/skills/productivity/teach/LEARNING-RECORD-FORMAT.md +46 -0
  46. package/template/skills/productivity/teach/MISSION-FORMAT.md +31 -0
  47. package/template/skills/productivity/teach/RESOURCES-FORMAT.md +32 -0
  48. package/template/skills/productivity/teach/SKILL.md +131 -0
  49. package/template/skills/productivity/write-a-skill/SKILL.md +117 -0
package/README.md CHANGED
@@ -6,7 +6,9 @@
6
6
 
7
7
  `ai-engineering-kit` scaffolds a repeatable workflow for building software with AI coding agents:
8
8
 
9
- - **Skills** — Markdown playbooks for each step: kickoff foundations PRD → plan → TDD → review → verify.
9
+ - **Skills** — Markdown playbooks, grouped into categories you pick at install time:
10
+ - **core-workflow** — kickoff → foundations → PRD → plan → implement → review → verify.
11
+ - **engineering**, **productivity**, **misc** — additional day-to-day skills forked from [`mattpocock/skills`](https://github.com/mattpocock/skills) (see attribution below).
10
12
  - **A structured workspace** — `ai/` for ephemeral artifacts (brainstorms, PRDs, plans, reviews) and `docs/foundations/` for canonical, long-lived project knowledge.
11
13
  - **Agent-agnostic wiring** — skills live as portable Markdown in `ai/skills/`; the kit generates the entry file each agent reads (`CLAUDE.md` + a `.claude/skills/` symlink for Claude Code, `AGENTS.md` for Codex). More agents are a template + a manifest entry away.
12
14
 
package/dist/cli.js CHANGED
@@ -22,26 +22,77 @@ function parseManifest(json) {
22
22
 
23
23
  // src/catalog/definition.ts
24
24
  var CATEGORIES = [
25
- { id: "core-workflow", label: "Core workflow", from: "skills/core-workflow", to: "ai/skills" }
25
+ {
26
+ id: "core-workflow",
27
+ label: "Core workflow",
28
+ hint: "End-to-end loop: kickoff \u2192 PRD \u2192 plan \u2192 implement \u2192 review \u2192 verify",
29
+ from: "skills/core-workflow",
30
+ to: "ai/skills"
31
+ },
32
+ {
33
+ id: "engineering",
34
+ label: "Engineering",
35
+ hint: "Daily coding skills \u2014 TDD, debugging, triage, architecture (from mattpocock/skills)",
36
+ from: "skills/engineering",
37
+ to: "ai/skills"
38
+ },
39
+ {
40
+ id: "productivity",
41
+ label: "Productivity",
42
+ hint: "Workflow helpers \u2014 grilling, handoff, teaching, concise mode (from mattpocock/skills)",
43
+ from: "skills/productivity",
44
+ to: "ai/skills"
45
+ },
46
+ {
47
+ id: "misc",
48
+ label: "Misc",
49
+ hint: "Occasional utilities \u2014 git guardrails, pre-commit, scaffolding (from mattpocock/skills)",
50
+ from: "skills/misc",
51
+ to: "ai/skills"
52
+ }
26
53
  ];
27
54
  var TREE_COMPONENTS = [
28
- { id: "docs-foundations", label: "docs/foundations scaffold", from: "docs/foundations", to: "docs/foundations" },
29
- { id: "ai-workspace", label: "ai/ workspace dirs", from: "ai-workspace", to: "ai" }
55
+ {
56
+ id: "docs-foundations",
57
+ label: "Foundation docs",
58
+ hint: "Starter docs for product vision, guidelines, and technical decisions (docs/foundations/)",
59
+ from: "docs/foundations",
60
+ to: "docs/foundations"
61
+ },
62
+ {
63
+ id: "ai-workspace",
64
+ label: "Workspace folders",
65
+ hint: "Folders the skills write to: brainstorms, PRDs, plans, reviews (ai/)",
66
+ from: "ai-workspace",
67
+ to: "ai"
68
+ }
30
69
  ];
31
70
  var COMPONENTS = [
32
- { id: "skills", label: "Skills", unlocks: "categories" },
33
- ...TREE_COMPONENTS.map((t) => ({ id: t.id, label: t.label })),
34
- { id: "entry-files", label: "Agent entry files", unlocks: "agents" }
71
+ {
72
+ id: "skills",
73
+ label: "Skills",
74
+ hint: "Reusable AI playbooks the agent runs on demand (plan, implement, review, debug\u2026)",
75
+ unlocks: "categories"
76
+ },
77
+ ...TREE_COMPONENTS.map((t) => ({ id: t.id, label: t.label, hint: t.hint })),
78
+ {
79
+ id: "entry-files",
80
+ label: "Agent entry files",
81
+ hint: "Instruction files that wire your coding agent to the skills (CLAUDE.md / AGENTS.md)",
82
+ unlocks: "agents"
83
+ }
35
84
  ];
36
85
  var AGENTS = [
37
86
  {
38
87
  id: "claude-code",
39
88
  label: "Claude Code",
89
+ hint: "Adds CLAUDE.md + a .claude/skills/ symlink for native skill discovery",
40
90
  files: [{ from: "agents/claude-code.CLAUDE.md", to: "CLAUDE.md", substitute: true }]
41
91
  },
42
92
  {
43
93
  id: "codex",
44
94
  label: "Codex",
95
+ hint: "Adds AGENTS.md referencing ai/skills/",
45
96
  files: [{ from: "agents/codex.AGENTS.md", to: "AGENTS.md", substitute: true }]
46
97
  }
47
98
  ];
@@ -292,13 +343,13 @@ import { multiselect, text, isCancel, cancel } from "@clack/prompts";
292
343
 
293
344
  // src/menu/menu.ts
294
345
  function componentOptions() {
295
- return COMPONENTS.map((c) => ({ value: c.id, label: c.label }));
346
+ return COMPONENTS.map((c) => ({ value: c.id, label: c.label, hint: c.hint }));
296
347
  }
297
348
  function categoryOptions() {
298
- return CATEGORIES.map((c) => ({ value: c.id, label: c.label }));
349
+ return CATEGORIES.map((c) => ({ value: c.id, label: c.label, hint: c.hint }));
299
350
  }
300
351
  function agentOptions() {
301
- return AGENTS.map((a) => ({ value: a.id, label: a.label }));
352
+ return AGENTS.map((a) => ({ value: a.id, label: a.label, hint: a.hint }));
302
353
  }
303
354
  function buildSelection(answers) {
304
355
  return {
@@ -316,33 +367,26 @@ function required(value) {
316
367
  }
317
368
  return value;
318
369
  }
319
- async function promptForSelection(projectDir) {
320
- const components = required(
370
+ var allValues = (options) => options.map((o) => o.value);
371
+ async function pickAll(message, options) {
372
+ return required(
321
373
  await multiselect({
322
- message: "Which parts do you want to install?",
323
- options: componentOptions(),
374
+ message: `${message} (everything is pre-selected \u2014 toggle off what you don't want)`,
375
+ options,
376
+ initialValues: allValues(options),
324
377
  required: true
325
378
  })
326
379
  );
380
+ }
381
+ async function promptForSelection(projectDir) {
382
+ const components = await pickAll("Which parts do you want to install?", componentOptions());
327
383
  let categories = [];
328
384
  if (components.includes("skills")) {
329
- categories = required(
330
- await multiselect({
331
- message: "Which skill categories?",
332
- options: categoryOptions(),
333
- required: true
334
- })
335
- );
385
+ categories = await pickAll("Which skill categories?", categoryOptions());
336
386
  }
337
387
  let agents = [];
338
388
  if (components.includes("entry-files")) {
339
- agents = required(
340
- await multiselect({
341
- message: "Which coding agents?",
342
- options: agentOptions(),
343
- required: true
344
- })
345
- );
389
+ agents = await pickAll("Which coding agents?", agentOptions());
346
390
  }
347
391
  const projectName = required(
348
392
  await text({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ai-engineering-kit",
3
- "version": "0.1.0",
3
+ "version": "0.3.0",
4
4
  "description": "An opinionated, agent-agnostic AI-development kit — disciplined skills plus a structured workspace — installed and updated through one npx command.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -0,0 +1,174 @@
1
+ ---
2
+ name: commit-organizer
3
+ description: Analyze all code changes across one or more repos and organize them into logical, separate conventional commits. Use when you have many unstaged/staged changes and want clean, atomic commits instead of one big commit.
4
+ argument-hint: "[repo-path]"
5
+ allowed-tools: Read, Bash(git *), Glob, Grep
6
+ ---
7
+
8
+ # Commit Organizer
9
+
10
+ Analyze all code changes (staged and unstaged) in the current directory. If the directory contains multiple git repos (a workspace root), analyze each repo independently. Organize changes into logical, atomic conventional commits.
11
+
12
+ ## How It Works
13
+
14
+ 1. Detect whether the current directory is a git repo or a workspace containing multiple repos
15
+ 2. For each repo, collect all modified, added, and untracked files
16
+ 3. Read the diffs and new file contents to understand what each change does
17
+ 4. Group related changes into logical commit units (e.g., a permission change + its test = one commit)
18
+ 5. Order commits so dependencies come first
19
+ 6. Present the commit plan to the user for approval
20
+ 7. Execute the commits one by one
21
+
22
+ ## Commit Message Rules
23
+
24
+ - Use conventional commits: `type(scope): description`
25
+ - Types: `feat`, `fix`, `refactor`, `style`, `docs`, `test`, `chore`
26
+ - One line only, max 72 characters
27
+ - Describe WHAT the change does from the user's perspective, not HOW
28
+ - Use imperative mood: "add", "fix", "ensure", "change", not "added", "fixes"
29
+ - Be specific — name the feature, the bug, the thing that changed
30
+
31
+ ### Good Examples
32
+
33
+ ```
34
+ feat: add per-card CSV export to Insights dashboard cards
35
+ feat: ensure bulk data export is only available to superAdmin users
36
+ fix: use YYYY/MM/DD date format in all CSV exports
37
+ refactor: extract shared RQS value mapping to exportUtils
38
+ feat: add export audit log with search and pagination
39
+ chore: add i18n keys for export and audit log UI
40
+ ```
41
+
42
+ ### Bad Examples
43
+
44
+ ```
45
+ update code # too vague
46
+ feat: changes to export # what changes?
47
+ fix: fix bug # what bug?
48
+ feat: add new feature # what feature?
49
+ refactor: refactor stuff # what stuff?
50
+ feat: implement export refactoring # describes the task, not the change
51
+ ```
52
+
53
+ ## Grouping Strategy
54
+
55
+ Group changes into commits by **logical intent**, not by file type:
56
+
57
+ - A backend permission change + frontend visibility change for the same feature = ONE commit
58
+ - A new utility file + the component that uses it = ONE commit (if tightly coupled)
59
+ - i18n keys can be grouped with the feature that uses them, or in a separate commit if they span multiple features
60
+ - Unrelated changes to different features = SEPARATE commits
61
+ - A new GraphQL schema + resolver + frontend query/mutation for one feature = ONE commit
62
+
63
+ When in doubt, prefer fewer, more meaningful commits over many tiny ones.
64
+
65
+ ## Execution
66
+
67
+ ### Step 1: Detect Repos
68
+
69
+ If `$ARGUMENTS` is provided, use it as the path. Otherwise use the current working directory.
70
+
71
+ ```bash
72
+ # Check if current dir is a git repo
73
+ git rev-parse --git-dir 2>/dev/null
74
+
75
+ # If not, find git repos one level deep (workspace mode)
76
+ for dir in */; do
77
+ if [ -d "$dir/.git" ]; then
78
+ echo "$dir"
79
+ fi
80
+ done
81
+ ```
82
+
83
+ ### Step 2: Collect Changes Per Repo
84
+
85
+ For each repo, run:
86
+
87
+ ```bash
88
+ git status -u # all changes including untracked (never use -uall)
89
+ git diff # unstaged changes
90
+ git diff --cached # staged changes
91
+ ```
92
+
93
+ For untracked files, read their contents to understand what they add.
94
+
95
+ ### Step 3: Analyze and Group
96
+
97
+ Read all diffs and new files. For each change, determine:
98
+ - What feature or concern does this belong to?
99
+ - Is it a feat, fix, refactor, style, docs, test, or chore?
100
+ - What other changes is it related to?
101
+
102
+ Group into commit units. Each unit has:
103
+ - A list of files to stage
104
+ - A commit message
105
+ - A brief rationale (for the user to review)
106
+
107
+ ### Step 4: Present Plan
108
+
109
+ Show the user a numbered list of proposed commits in order:
110
+
111
+ ```
112
+ Repository: cliezen-graph
113
+
114
+ 1. feat: restrict bulk CSV export to superAdmin users
115
+ Files: routes/exportCsv.js
116
+
117
+ 2. fix: use YYYY/MM/DD date format in bulk CSV exports
118
+ Files: routes/exports/csv.js
119
+
120
+ Repository: cliezen-dashboard
121
+
122
+ 3. feat: add shared export utilities and CSV formatters
123
+ Files: src/utils/exportUtils.js, src/utils/cardExportFormatters.js
124
+
125
+ 4. feat: add per-card CSV export to Insights dashboard cards
126
+ Files: src/composables/useCardExport.js, src/components/Insights/DashCard.vue, src/graphql/mutations.js
127
+ ```
128
+
129
+ Ask the user: "Does this commit plan look good? You can adjust, reorder, merge, or split any commits."
130
+
131
+ Wait for approval before proceeding. If the user says "go" or "yes" or "looks good", execute. If they request changes, adjust and re-present.
132
+
133
+ ### Step 5: Execute Commits
134
+
135
+ For each commit unit, in order:
136
+
137
+ ```bash
138
+ cd <repo-path>
139
+ git add <file1> <file2> ... # stage only files for this commit
140
+ git commit -m "<message>" # commit with the planned message
141
+ ```
142
+
143
+ After each commit, confirm success before moving to the next.
144
+
145
+ If a commit fails (e.g., pre-commit hook), stop and report the error. Do not skip or force.
146
+
147
+ ### Step 6: Summary
148
+
149
+ After all commits are done, show a summary:
150
+
151
+ ```
152
+ Done! Created N commits across M repos:
153
+
154
+ cliezen-graph (2 commits):
155
+ abc1234 feat: restrict bulk CSV export to superAdmin users
156
+ def5678 fix: use YYYY/MM/DD date format in bulk CSV exports
157
+
158
+ cliezen-dashboard (4 commits):
159
+ 111aaaa feat: add shared export utilities and CSV formatters
160
+ 222bbbb feat: add per-card CSV export to Insights dashboard cards
161
+ ...
162
+ ```
163
+
164
+ ## Edge Cases
165
+
166
+ - If there are no changes in a repo, skip it silently
167
+ - If all changes belong to one logical unit, make one commit (don't force artificial splits)
168
+ - If a file has changes belonging to two different features, note this and ask the user how to handle it (commit the whole file with the more significant change, or suggest the user manually split it with `git add -p`)
169
+ - Never run `git add .` or `git add -A` — always stage specific files
170
+ - Never amend existing commits
171
+ - Never force push
172
+ - Never use `--no-verify`
173
+ - Never add Co-Authored-By, Signed-off-by, or any AI attribution trailers to commit messages
174
+ - Commit messages are the developer's own — no mention of Claude, AI, or any tool
@@ -0,0 +1,117 @@
1
+ ---
2
+ name: diagnose
3
+ description: Disciplined diagnosis loop for hard bugs and performance regressions. Reproduce → minimise → hypothesise → instrument → fix → regression-test. Use when user says "diagnose this" / "debug this", reports a bug, says something is broken/throwing/failing, or describes a performance regression.
4
+ ---
5
+
6
+ # Diagnose
7
+
8
+ A discipline for hard bugs. Skip phases only when explicitly justified.
9
+
10
+ When exploring the codebase, use the project's domain glossary to get a clear mental model of the relevant modules, and check ADRs in the area you're touching.
11
+
12
+ ## Phase 1 — Build a feedback loop
13
+
14
+ **This is the skill.** Everything else is mechanical. If you have a fast, deterministic, agent-runnable pass/fail signal for the bug, you will find the cause — bisection, hypothesis-testing, and instrumentation all just consume that signal. If you don't have one, no amount of staring at code will save you.
15
+
16
+ Spend disproportionate effort here. **Be aggressive. Be creative. Refuse to give up.**
17
+
18
+ ### Ways to construct one — try them in roughly this order
19
+
20
+ 1. **Failing test** at whatever seam reaches the bug — unit, integration, e2e.
21
+ 2. **Curl / HTTP script** against a running dev server.
22
+ 3. **CLI invocation** with a fixture input, diffing stdout against a known-good snapshot.
23
+ 4. **Headless browser script** (Playwright / Puppeteer) — drives the UI, asserts on DOM/console/network.
24
+ 5. **Replay a captured trace.** Save a real network request / payload / event log to disk; replay it through the code path in isolation.
25
+ 6. **Throwaway harness.** Spin up a minimal subset of the system (one service, mocked deps) that exercises the bug code path with a single function call.
26
+ 7. **Property / fuzz loop.** If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
27
+ 8. **Bisection harness.** If the bug appeared between two known states (commit, dataset, version), automate "boot at state X, check, repeat" so you can `git bisect run` it.
28
+ 9. **Differential loop.** Run the same input through old-version vs new-version (or two configs) and diff outputs.
29
+ 10. **HITL bash script.** Last resort. If a human must click, drive _them_ with `scripts/hitl-loop.template.sh` so the loop is still structured. Captured output feeds back to you.
30
+
31
+ Build the right feedback loop, and the bug is 90% fixed.
32
+
33
+ ### Iterate on the loop itself
34
+
35
+ Treat the loop as a product. Once you have _a_ loop, ask:
36
+
37
+ - Can I make it faster? (Cache setup, skip unrelated init, narrow the test scope.)
38
+ - Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
39
+ - Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)
40
+
41
+ A 30-second flaky loop is barely better than no loop. A 2-second deterministic loop is a debugging superpower.
42
+
43
+ ### Non-deterministic bugs
44
+
45
+ The goal is not a clean repro but a **higher reproduction rate**. Loop the trigger 100×, parallelise, add stress, narrow timing windows, inject sleeps. A 50%-flake bug is debuggable; 1% is not — keep raising the rate until it's debuggable.
46
+
47
+ ### When you genuinely cannot build a loop
48
+
49
+ Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a captured artifact (HAR file, log dump, core dump, screen recording with timestamps), or (c) permission to add temporary production instrumentation. Do **not** proceed to hypothesise without a loop.
50
+
51
+ Do not proceed to Phase 2 until you have a loop you believe in.
52
+
53
+ ## Phase 2 — Reproduce
54
+
55
+ Run the loop. Watch the bug appear.
56
+
57
+ Confirm:
58
+
59
+ - [ ] The loop produces the failure mode the **user** described — not a different failure that happens to be nearby. Wrong bug = wrong fix.
60
+ - [ ] The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
61
+ - [ ] You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.
62
+
63
+ Do not proceed until you reproduce the bug.
64
+
65
+ ## Phase 3 — Hypothesise
66
+
67
+ Generate **3–5 ranked hypotheses** before testing any of them. Single-hypothesis generation anchors on the first plausible idea.
68
+
69
+ Each hypothesis must be **falsifiable**: state the prediction it makes.
70
+
71
+ > Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."
72
+
73
+ If you cannot state the prediction, the hypothesis is a vibe — discard or sharpen it.
74
+
75
+ **Show the ranked list to the user before testing.** They often have domain knowledge that re-ranks instantly ("we just deployed a change to #3"), or know hypotheses they've already ruled out. Cheap checkpoint, big time saver. Don't block on it — proceed with your ranking if the user is AFK.
76
+
77
+ ## Phase 4 — Instrument
78
+
79
+ Each probe must map to a specific prediction from Phase 3. **Change one variable at a time.**
80
+
81
+ Tool preference:
82
+
83
+ 1. **Debugger / REPL inspection** if the env supports it. One breakpoint beats ten logs.
84
+ 2. **Targeted logs** at the boundaries that distinguish hypotheses.
85
+ 3. Never "log everything and grep".
86
+
87
+ **Tag every debug log** with a unique prefix, e.g. `[DEBUG-a4f2]`. Cleanup at the end becomes a single grep. Untagged logs survive; tagged logs die.
88
+
89
+ **Perf branch.** For performance regressions, logs are usually wrong. Instead: establish a baseline measurement (timing harness, `performance.now()`, profiler, query plan), then bisect. Measure first, fix second.
90
+
91
+ ## Phase 5 — Fix + regression test
92
+
93
+ Write the regression test **before the fix** — but only if there is a **correct seam** for it.
94
+
95
+ A correct seam is one where the test exercises the **real bug pattern** as it occurs at the call site. If the only available seam is too shallow (single-caller test when the bug needs multiple callers, unit test that can't replicate the chain that triggered the bug), a regression test there gives false confidence.
96
+
97
+ **If no correct seam exists, that itself is the finding.** Note it. The codebase architecture is preventing the bug from being locked down. Flag this for the next phase.
98
+
99
+ If a correct seam exists:
100
+
101
+ 1. Turn the minimised repro into a failing test at that seam.
102
+ 2. Watch it fail.
103
+ 3. Apply the fix.
104
+ 4. Watch it pass.
105
+ 5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.
106
+
107
+ ## Phase 6 — Cleanup + post-mortem
108
+
109
+ Required before declaring done:
110
+
111
+ - [ ] Original repro no longer reproduces (re-run the Phase 1 loop)
112
+ - [ ] Regression test passes (or absence of seam is documented)
113
+ - [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
114
+ - [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
115
+ - [ ] The hypothesis that turned out correct is stated in the commit / PR message — so the next debugger learns
116
+
117
+ **Then ask: what would have prevented this bug?** If the answer involves architectural change (no good test seam, tangled callers, hidden coupling) hand off to the `/improve-codebase-architecture` skill with the specifics. Make the recommendation **after** the fix is in, not before — you have more information now than when you started.
@@ -0,0 +1,41 @@
1
+ #!/usr/bin/env bash
2
+ # Human-in-the-loop reproduction loop.
3
+ # Copy this file, edit the steps below, and run it.
4
+ # The agent runs the script; the user follows prompts in their terminal.
5
+ #
6
+ # Usage:
7
+ # bash hitl-loop.template.sh
8
+ #
9
+ # Two helpers:
10
+ # step "<instruction>" → show instruction, wait for Enter
11
+ # capture VAR "<question>" → show question, read response into VAR
12
+ #
13
+ # At the end, captured values are printed as KEY=VALUE for the agent to parse.
14
+
15
+ set -euo pipefail
16
+
17
+ step() {
18
+ printf '\n>>> %s\n' "$1"
19
+ read -r -p " [Enter when done] " _
20
+ }
21
+
22
+ capture() {
23
+ local var="$1" question="$2" answer
24
+ printf '\n>>> %s\n' "$question"
25
+ read -r -p " > " answer
26
+ printf -v "$var" '%s' "$answer"
27
+ }
28
+
29
+ # --- edit below ---------------------------------------------------------
30
+
31
+ step "Open the app at http://localhost:3000 and sign in."
32
+
33
+ capture ERRORED "Click the 'Export' button. Did it throw an error? (y/n)"
34
+
35
+ capture ERROR_MSG "Paste the error message (or 'none'):"
36
+
37
+ # --- edit above ---------------------------------------------------------
38
+
39
+ printf '\n--- Captured ---\n'
40
+ printf 'ERRORED=%s\n' "$ERRORED"
41
+ printf 'ERROR_MSG=%s\n' "$ERROR_MSG"
@@ -0,0 +1,47 @@
1
+ # ADR Format
2
+
3
+ ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
4
+
5
+ Create the `docs/adr/` directory lazily — only when the first ADR is needed.
6
+
7
+ ## Template
8
+
9
+ ```md
10
+ # {Short title of the decision}
11
+
12
+ {1-3 sentences: what's the context, what did we decide, and why.}
13
+ ```
14
+
15
+ That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why* — not in filling out sections.
16
+
17
+ ## Optional sections
18
+
19
+ Only include these when they add genuine value. Most ADRs won't need them.
20
+
21
+ - **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`) — useful when decisions are revisited
22
+ - **Considered Options** — only when the rejected alternatives are worth remembering
23
+ - **Consequences** — only when non-obvious downstream effects need to be called out
24
+
25
+ ## Numbering
26
+
27
+ Scan `docs/adr/` for the highest existing number and increment by one.
28
+
29
+ ## When to offer an ADR
30
+
31
+ All three of these must be true:
32
+
33
+ 1. **Hard to reverse** — the cost of changing your mind later is meaningful
34
+ 2. **Surprising without context** — a future reader will look at the code and wonder "why on earth did they do it this way?"
35
+ 3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
36
+
37
+ If a decision is easy to reverse, skip it — you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."
38
+
39
+ ### What qualifies
40
+
41
+ - **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
42
+ - **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
43
+ - **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library — just the ones that would take a quarter to swap out.
44
+ - **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
45
+ - **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
46
+ - **Constraints not visible in the code.** "We can't use AWS because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
47
+ - **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it — otherwise someone will suggest GraphQL again in six months.
@@ -0,0 +1,60 @@
1
+ # CONTEXT.md Format
2
+
3
+ ## Structure
4
+
5
+ ```md
6
+ # {Context Name}
7
+
8
+ {One or two sentence description of what this context is and why it exists.}
9
+
10
+ ## Language
11
+
12
+ **Order**:
13
+ {A one or two sentence description of the term}
14
+ _Avoid_: Purchase, transaction
15
+
16
+ **Invoice**:
17
+ A request for payment sent to a customer after delivery.
18
+ _Avoid_: Bill, payment request
19
+
20
+ **Customer**:
21
+ A person or organization that places orders.
22
+ _Avoid_: Client, buyer, account
23
+ ```
24
+
25
+ ## Rules
26
+
27
+ - **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others under `_Avoid_`.
28
+ - **Keep definitions tight.** One or two sentences max. Define what it IS, not what it does.
29
+ - **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
30
+ - **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
31
+
32
+ ## Single vs multi-context repos
33
+
34
+ **Single context (most repos):** One `CONTEXT.md` at the repo root.
35
+
36
+ **Multiple contexts:** A `CONTEXT-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:
37
+
38
+ ```md
39
+ # Context Map
40
+
41
+ ## Contexts
42
+
43
+ - [Ordering](./src/ordering/CONTEXT.md) — receives and tracks customer orders
44
+ - [Billing](./src/billing/CONTEXT.md) — generates invoices and processes payments
45
+ - [Fulfillment](./src/fulfillment/CONTEXT.md) — manages warehouse picking and shipping
46
+
47
+ ## Relationships
48
+
49
+ - **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
50
+ - **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
51
+ - **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
52
+ ```
53
+
54
+ The skill infers which structure applies:
55
+
56
+ - If `CONTEXT-MAP.md` exists, read it to find contexts
57
+ - If only a root `CONTEXT.md` exists, single context
58
+ - If neither exists, create a root `CONTEXT.md` lazily when the first term is resolved
59
+
60
+ When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.