@heihei0299/matt-skills 2.1.13 → 3.0.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/README.md +3 -2
- package/bin/cli.js +51 -122
- package/bin/skill-boundaries.js +0 -8
- package/bin/skill-config.js +21 -0
- package/bin/skill-selection.js +27 -0
- package/config/required.json +5 -0
- package/package.json +2 -1
- package/scripts/sync-upstream.js +3 -12
- package/template/.opencode/CONTEXT.md +7 -7
- package/template/.pi/CONTEXT.md +7 -7
- package/template/.agents/skills/ask-matt/PHASE-BOUNDARIES.md +0 -55
- package/template/.agents/skills/ask-matt/SKILL.md +0 -90
- package/template/.agents/skills/ask-matt/agents/openai.yaml +0 -5
- package/template/.agents/skills/code-review/SKILL.md +0 -87
- package/template/.agents/skills/code-review/agents/openai.yaml +0 -3
- package/template/.agents/skills/codebase-design/DEEPENING.md +0 -37
- package/template/.agents/skills/codebase-design/DESIGN-IT-TWICE.md +0 -44
- package/template/.agents/skills/codebase-design/SKILL.md +0 -114
- package/template/.agents/skills/codebase-design/agents/openai.yaml +0 -3
- package/template/.agents/skills/diagnose-fix/SKILL.md +0 -43
- package/template/.agents/skills/diagnose-fix/agents/openai.yaml +0 -5
- package/template/.agents/skills/diagnose-fix/references/anti-patterns.md +0 -21
- package/template/.agents/skills/diagnosing-bugs/SKILL.md +0 -138
- package/template/.agents/skills/diagnosing-bugs/agents/openai.yaml +0 -3
- package/template/.agents/skills/diagnosing-bugs/scripts/hitl-loop.template.sh +0 -44
- package/template/.agents/skills/domain-modeling/ADR-FORMAT.md +0 -47
- package/template/.agents/skills/domain-modeling/CONTEXT-FORMAT.md +0 -60
- package/template/.agents/skills/domain-modeling/SKILL.md +0 -74
- package/template/.agents/skills/domain-modeling/agents/openai.yaml +0 -3
- package/template/.agents/skills/grill-me/SKILL.md +0 -7
- package/template/.agents/skills/grill-me/agents/openai.yaml +0 -5
- package/template/.agents/skills/grill-to-spec/SKILL.md +0 -55
- package/template/.agents/skills/grill-to-spec/agents/openai.yaml +0 -5
- package/template/.agents/skills/grill-to-spec/references/rules.md +0 -47
- package/template/.agents/skills/grill-with-docs/SKILL.md +0 -7
- package/template/.agents/skills/grill-with-docs/agents/openai.yaml +0 -5
- package/template/.agents/skills/grilling/SKILL.md +0 -28
- package/template/.agents/skills/grilling/agents/openai.yaml +0 -3
- package/template/.agents/skills/handoff/SKILL.md +0 -16
- package/template/.agents/skills/handoff/agents/openai.yaml +0 -5
- package/template/.agents/skills/implement/SKILL.md +0 -15
- package/template/.agents/skills/implement/agents/openai.yaml +0 -5
- package/template/.agents/skills/implement-review-loop/SKILL.md +0 -34
- package/template/.agents/skills/implement-review-loop/agents/openai.yaml +0 -5
- package/template/.agents/skills/improve-codebase-architecture/HTML-REPORT.md +0 -123
- package/template/.agents/skills/improve-codebase-architecture/SKILL.md +0 -71
- package/template/.agents/skills/improve-codebase-architecture/agents/openai.yaml +0 -5
- package/template/.agents/skills/instance-test/SKILL.md +0 -70
- package/template/.agents/skills/instance-test/agents/openai.yaml +0 -5
- package/template/.agents/skills/instance-test/references/instances.md +0 -75
- package/template/.agents/skills/prototype/LOGIC.md +0 -67
- package/template/.agents/skills/prototype/SKILL.md +0 -26
- package/template/.agents/skills/prototype/UI.md +0 -112
- package/template/.agents/skills/prototype/agents/openai.yaml +0 -3
- package/template/.agents/skills/research/SKILL.md +0 -12
- package/template/.agents/skills/research/agents/openai.yaml +0 -3
- package/template/.agents/skills/resolving-merge-conflicts/SKILL.md +0 -14
- package/template/.agents/skills/resolving-merge-conflicts/agents/openai.yaml +0 -3
- package/template/.agents/skills/scaffold-functional-test/SKILL.md +0 -64
- package/template/.agents/skills/scaffold-functional-test/agents/openai.yaml +0 -5
- package/template/.agents/skills/scaffold-functional-test/references/schema.md +0 -80
- package/template/.agents/skills/setup-matt-pocock-skills/SKILL.md +0 -116
- package/template/.agents/skills/setup-matt-pocock-skills/agents/openai.yaml +0 -5
- package/template/.agents/skills/setup-matt-pocock-skills/domain.md +0 -51
- package/template/.agents/skills/setup-matt-pocock-skills/issue-tracker-github.md +0 -45
- package/template/.agents/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +0 -46
- package/template/.agents/skills/setup-matt-pocock-skills/issue-tracker-local.md +0 -30
- package/template/.agents/skills/setup-matt-pocock-skills/triage-labels.md +0 -15
- package/template/.agents/skills/show-me/SKILL.md +0 -28
- package/template/.agents/skills/tdd/SKILL.md +0 -38
- package/template/.agents/skills/tdd/agents/openai.yaml +0 -3
- package/template/.agents/skills/tdd/mocking.md +0 -59
- package/template/.agents/skills/tdd/tests.md +0 -77
- package/template/.agents/skills/tdd-implement/SKILL.md +0 -81
- package/template/.agents/skills/tdd-implement/agents/openai.yaml +0 -5
- package/template/.agents/skills/tdd-implement/references/finalize.md +0 -16
- package/template/.agents/skills/tdd-implement/references/orchestration.md +0 -54
- package/template/.agents/skills/tdd-implement/references/verify.md +0 -15
- package/template/.agents/skills/teach/GLOSSARY-FORMAT.md +0 -35
- package/template/.agents/skills/teach/LEARNING-RECORD-FORMAT.md +0 -46
- package/template/.agents/skills/teach/MISSION-FORMAT.md +0 -31
- package/template/.agents/skills/teach/RESOURCES-FORMAT.md +0 -32
- package/template/.agents/skills/teach/SKILL.md +0 -140
- package/template/.agents/skills/teach/agents/openai.yaml +0 -5
- package/template/.agents/skills/to-questionnaire/SKILL.md +0 -54
- package/template/.agents/skills/to-questionnaire/agents/openai.yaml +0 -5
- package/template/.agents/skills/to-spec/SKILL.md +0 -75
- package/template/.agents/skills/to-spec/agents/openai.yaml +0 -5
- package/template/.agents/skills/to-tickets/SKILL.md +0 -105
- package/template/.agents/skills/to-tickets/agents/openai.yaml +0 -5
- package/template/.agents/skills/triage/AGENT-BRIEF.md +0 -207
- package/template/.agents/skills/triage/OUT-OF-SCOPE.md +0 -105
- package/template/.agents/skills/triage/SKILL.md +0 -112
- package/template/.agents/skills/triage/agents/openai.yaml +0 -5
- package/template/.agents/skills/wait-what/SKILL.md +0 -7
- package/template/.agents/skills/wait-what/agents/openai.yaml +0 -5
- package/template/.agents/skills/wayfinder/SKILL.md +0 -128
- package/template/.agents/skills/wayfinder/agents/openai.yaml +0 -5
- package/template/.agents/skills/wizard/SKILL.md +0 -44
- package/template/.agents/skills/wizard/agents/openai.yaml +0 -3
- package/template/.agents/skills/wizard/template.sh +0 -204
- package/template/.agents/skills/writing-for-agents/SKILL-MECHANICS.md +0 -22
- package/template/.agents/skills/writing-for-agents/SKILL.md +0 -81
- package/template/.agents/skills/writing-for-agents/agents/openai.yaml +0 -3
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: ask-matt
|
|
3
|
-
description: Ask which skill or flow fits your situation. A router over the skills in this repo.
|
|
4
|
-
disable-model-invocation: true
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Ask Matt
|
|
8
|
-
|
|
9
|
-
You don't remember every skill, so ask.
|
|
10
|
-
|
|
11
|
-
A **flow** is a path through the skills. Most paths run along one **main flow**, and two **on-ramps** merge onto it. Everything else is standalone, or a vocabulary layer that runs underneath.
|
|
12
|
-
|
|
13
|
-
## The main flow: idea → ship
|
|
14
|
-
|
|
15
|
-
The route most work travels. You have an idea and want it built.
|
|
16
|
-
|
|
17
|
-
1. **`/grill-with-docs`** sharpens the idea by interview. Start here whenever you are **working in a working directory**: it's stateful, retaining what it learns in `CONTEXT.md` and ADRs. (No working directory? Use `/grill-me` instead, covered under Standalone. Both run the same `/grilling` primitive; `grill-with-docs` is the one that leaves a paper trail, which makes it the better of the two whenever a repo is there to leave it in.)
|
|
18
|
-
2. **Branch: can you settle every question in conversation?** If a question needs a runnable answer (state, business logic, a UI you have to see), detour through a prototype, bridged by **`/handoff`** in both directions (a prototype lives in its own directory, which is exactly what `/handoff` is for; see Phase boundaries):
|
|
19
|
-
- **`/handoff`** out, then open a fresh session against that file,
|
|
20
|
-
- **`/prototype`** to answer the question with throwaway code,
|
|
21
|
-
- **`/handoff`** back what you learned, and reference it from the original idea thread.
|
|
22
|
-
3. **Branch: is this a multi-session build?**
|
|
23
|
-
- **Yes** → **`/to-spec`** (turn the thread into a spec), then **`/to-tickets`** to split it into tracer-bullet tickets, each declaring its **blocking edges**. On a local tracker that's one file per ticket under `.scratch/<feature>/issues/`, worked blockers-first by hand; on a real tracker the edges become native blocking links, so any ticket whose blockers are done can be grabbed: kick off **`/implement`** per ticket, **`/clear`ing context between each one**. Each ticket is self-contained, so the last one's context is disposable.
|
|
24
|
-
- **No** → **`/implement`** right here, in the same context window.
|
|
25
|
-
|
|
26
|
-
Either way, **`/implement`** builds each issue by driving **`/tdd`** internally (one red-green slice at a time), then closes out by running **`/code-review`**, a two-axis review (Standards + Spec) of the diff, before committing. Reach for **`/tdd`** on its own when you just want to build a concrete behaviour test-first without a full spec, and **`/code-review`** on its own whenever you want to review a branch or PR against a fixed point.
|
|
27
|
-
|
|
28
|
-
### Context hygiene
|
|
29
|
-
|
|
30
|
-
Keep steps 1–3 in **one unbroken context window** (don't compact or clear until after `/to-tickets`) so the grilling, spec, and tickets all build on the same thinking. Each `/implement` then starts fresh, working from the ticket.
|
|
31
|
-
|
|
32
|
-
The limit on this is the **[smart zone](https://www.aihero.dev/ai-coding-dictionary/smart-zone)**: the window (~150k tokens on state-of-the-art models) within which the model still reasons sharply. If a session approaches it before `/to-tickets`, don't push on degraded; `/compact` at the nearest phase boundary and carry on (see Phase boundaries).
|
|
33
|
-
|
|
34
|
-
## On-ramps
|
|
35
|
-
|
|
36
|
-
A starting situation that generates work, then merges onto the main flow.
|
|
37
|
-
|
|
38
|
-
- **Bugs and requests piling up** → **`/triage`**. It moves issues through triage roles and produces agent-ready issues, which **`/implement`** later picks up.
|
|
39
|
-
|
|
40
|
-
Triage is only for issues **you didn't create**: bug reports, incoming feature requests, anything that arrives raw. Tickets that `/to-tickets` produced are already agent-ready, so **don't triage them**.
|
|
41
|
-
|
|
42
|
-
- **Something's broken** → **`/diagnosing-bugs`**. For the hard ones: the bug that resists a first glance, the intermittent flake, the regression that crept in between two known-good states. It refuses to theorise until it has a **tight feedback loop** (one command that already goes red on *this* bug), then fixes with a regression test. Its post-mortem hands off to **`/improve-codebase-architecture`** when the real finding is that there's no good seam to lock the bug down.
|
|
43
|
-
|
|
44
|
-
- **A huge, foggy effort: a greenfield project or a huge feature build, too big for one session** → **`/wayfinder`**, the most cognitively demanding flow here. When the way from here to the destination isn't visible yet, it charts a **shared map** of **decision tickets** on the issue tracker and resolves them one at a time, producing **decisions, not deliverables**, until the fog is pushed back and the way is clear. Where **`/grill-with-docs`** sharpens an idea you can hold in one session, wayfinder is for the idea you can't, and it's slower and denser, so save it for exactly that, never a well-scoped feature.
|
|
45
|
-
|
|
46
|
-
When the map clears, **it hands off, it doesn't build**: merge onto the main flow at **`/to-spec`**, which collapses the map's linked decisions into a buildable plan, then `/to-tickets` and `/implement` as usual. Looping the map straight into `/implement` skips that collapse and throws the linked detail away, so go straight to `/implement` only when the effort turned out genuinely small.
|
|
47
|
-
|
|
48
|
-
## Codebase health
|
|
49
|
-
|
|
50
|
-
Not feature work, just upkeep.
|
|
51
|
-
|
|
52
|
-
- **`/improve-codebase-architecture`** runs whenever you have a spare moment to keep the codebase good for agents to operate in. It surfaces **deepening opportunities**; picking one _generates an idea_ you can take into the main flow at `/grill-with-docs`. It's the survey that finds the candidates; **`/codebase-design`** (below) is the bench you design the chosen one on.
|
|
53
|
-
|
|
54
|
-
## Vocabulary underneath
|
|
55
|
-
|
|
56
|
-
Two model-invoked references that run *beneath* the other skills, each the single source of truth for its vocabulary. Reach for them directly when the **words**, not the process, are the problem; or let the skills above pull them in.
|
|
57
|
-
|
|
58
|
-
- **`/domain-modeling`**: sharpen the project's *domain* language: challenge a fuzzy term, resolve an overloaded word ("account" doing three jobs), record a hard-to-reverse decision as an ADR. It's the active discipline `/grill-with-docs` drives to keep `CONTEXT.md` a clean glossary.
|
|
59
|
-
- **`/codebase-design`** is the deep-module vocabulary (module, interface, depth, seam, adapter, leverage, locality) for designing a module's *shape*: a lot of behaviour behind a small interface at a clean seam. `/tdd` and `/improve-codebase-architecture` both speak it.
|
|
60
|
-
|
|
61
|
-
## Phase boundaries
|
|
62
|
-
|
|
63
|
-
A **phase** is a chunk of work inside a session: the grilling, the implementation, the QA. At the **boundary** between two of them you have five options, and picking between them is the fuzziest decision in this whole map:
|
|
64
|
-
|
|
65
|
-
- **Continue**: stay put. Costs nothing, loses nothing.
|
|
66
|
-
- **`/clear`**: empty the window, when nothing here matters to what's next.
|
|
67
|
-
- **`/handoff`** writes a portable markdown file. Narrow: only for a **new harness**, a **new directory**, a **colleague**, or forking a side task **mid-phase**. What it buys is portability.
|
|
68
|
-
- **Subagent**: send a tightly-scoped task to its own window and get a report back.
|
|
69
|
-
- **`/compact`** compresses this context and seeds a fresh session with it. The **default**, at the bottom of the tree rather than the first reach.
|
|
70
|
-
|
|
71
|
-
Read [PHASE-BOUNDARIES.md](PHASE-BOUNDARIES.md) for the ordered tree: the five questions, the reasoning behind each branch, and why the primary-source cost makes **Continue** the one to rule out first. Make the decision **at** a boundary; mid-phase, continue or split the rest into subagents.
|
|
72
|
-
|
|
73
|
-
## Standalone
|
|
74
|
-
|
|
75
|
-
Off the main flow entirely.
|
|
76
|
-
|
|
77
|
-
- **`/grill-me`**: the same relentless interview as `/grill-with-docs`, but **stateless**: it saves nothing locally and builds no `CONTEXT.md`. Reach for it when you are **not working in a working directory** (sharpening a plan, a design, a piece of writing, anything with no repo under it). If you are in a working directory, use `/grill-with-docs` instead: it runs the same interview and leaves a paper trail, so it is strictly the better one.
|
|
78
|
-
- **`/grilling`** is the interview primitive itself: rounds, the frontier, facts are the agent's job and decisions are yours. `/grill-me` and `/grill-with-docs` are the two named ways in, and `/triage`, `/wayfinder` and `/improve-codebase-architecture` all run it internally. Reach for it directly only when you want the interview with no wrapper around it.
|
|
79
|
-
- **`/resolving-merge-conflicts`** works an in-progress merge or rebase conflict hunk by hunk, resolving by **intent** traced to each side's primary source rather than by picking lines, then finishes the operation. It never runs `--abort`. Standalone and off every flow: reach for it when you are already mid-conflict.
|
|
80
|
-
- **`/prototype`** is a small, throwaway program that answers one design question: does this state model feel right, or what should this UI look like. Throwaway is a constraint on how the code is written, not a promise to destroy it: the answer folds into the real code, and the prototype itself is kept as a **primary source** on a `prototype/<name>` branch out of main, pointed at from the implementation issue. It's the detour in step 2 of the main flow, but reach for it any time a design question is hard to settle on paper.
|
|
81
|
-
- **`/research`**: delegate reading legwork to a **background agent**: it investigates a question against **primary sources**, then leaves a cited Markdown file in the repo. Keep working while it reads. The file it produces is something to take *into* the main flow at `/grill-with-docs`, since research feeds the thinking rather than replacing it.
|
|
82
|
-
- **`/to-questionnaire`** comes in when the thing blocking you isn't in your head or the codebase but in **someone else's**, and it writes them a questionnaire to fill in. It's the inverse of `/grill-me`: instead of interviewing you about the subject, it interviews you about the **send** (who it's going to, what you need back) and aims the questions at the gap. What comes back is material for `/grill-with-docs` or `/to-spec`.
|
|
83
|
-
- **`/wizard`** is for the steps only a **human** can take: provisioning infrastructure, setting up credentials or CI secrets, clicking through an unfamiliar third-party dashboard, running a one-off migration or cutover. It generates an interactive bash script that opens each URL, captures each value, and writes it into `.env` and GitHub secrets, so the procedure stops being something you re-explain to an agent every time. Model-invoked, so the agent reaches for it the moment it hits a wall only you can pass. If the agent could just do it itself, it should; this is for where a human is genuinely in the loop.
|
|
84
|
-
- **`/wait-what`** is the corrective for a message that didn't land. Use it mid-conversation, inside any other skill, and the agent re-pitches what it just said with the context you were missing, in plain English, using the `CONTEXT.md` vocabulary. It works after the fact; `/grill-with-docs` is the upfront cure, because a shared language agreed early is what stops the jargon arriving at all.
|
|
85
|
-
- **`/teach`**: learn a concept over multiple sessions, using the current directory as a stateful workspace.
|
|
86
|
-
- **`/writing-for-agents`** is the reference for writing documents agents consume: skills, AGENTS.md, pointed-at docs.
|
|
87
|
-
|
|
88
|
-
## Precondition
|
|
89
|
-
|
|
90
|
-
**`/setup-matt-pocock-skills`**: run before your first engineering flow to configure the issue tracker, triage labels, and doc layout the other skills assume. Custom issue trackers also work.
|
|
@@ -1,87 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: code-review
|
|
3
|
-
description: "Review the changes since a fixed point (commit, branch, tag, or merge-base) along two axes: Standards (does the code follow this repo's documented coding standards?) and Spec (does the code match what the originating issue/spec asked for?). Runs both reviews in parallel sub-agents and reports them side by side. Use when the user wants to review a branch, a PR, work-in-progress changes, or asks to \"review since X\"."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
Two-axis review of the diff between `HEAD` and a fixed point the user supplies:
|
|
7
|
-
|
|
8
|
-
- **Standards**: does the code conform to this repo's documented coding standards?
|
|
9
|
-
- **Spec**: does the code faithfully implement the originating issue / spec?
|
|
10
|
-
|
|
11
|
-
Both axes run as **parallel sub-agents** so they don't pollute each other's context, then this skill aggregates their findings.
|
|
12
|
-
|
|
13
|
-
The issue tracker should have been provided to you. If `docs/agents/issue-tracker.md` is missing, tell the user to run `/setup-matt-pocock-skills`.
|
|
14
|
-
|
|
15
|
-
## Process
|
|
16
|
-
|
|
17
|
-
### 1. Pin the fixed point
|
|
18
|
-
|
|
19
|
-
Whatever the user said is the fixed point (a commit SHA, branch name, tag, `main`, `HEAD~5`, etc.). If they didn't specify one, ask for it.
|
|
20
|
-
|
|
21
|
-
Capture the diff command once: `git diff <fixed-point>...HEAD` (three-dot, so the comparison is against the merge-base). Also note the list of commits via `git log <fixed-point>..HEAD --oneline`.
|
|
22
|
-
|
|
23
|
-
Before going further, confirm the fixed point resolves (`git rev-parse <fixed-point>`) and the diff is non-empty. A bad ref or empty diff should fail here, not inside two parallel sub-agents.
|
|
24
|
-
|
|
25
|
-
### 2. Identify the spec source
|
|
26
|
-
|
|
27
|
-
Look for the originating spec, in this order:
|
|
28
|
-
|
|
29
|
-
1. Issue references in the commit messages (`#123`, `Closes #45`, GitLab `!67`, etc.), fetched via the workflow in `docs/agents/issue-tracker.md`.
|
|
30
|
-
2. A path the user passed as an argument.
|
|
31
|
-
3. A spec file under `docs/`, `specs/`, or `.scratch/` matching the branch name or feature.
|
|
32
|
-
4. If nothing is found, ask the user where the spec is. If they say there isn't one, the **Spec** sub-agent will skip and report "no spec available".
|
|
33
|
-
|
|
34
|
-
### 3. Identify the standards sources
|
|
35
|
-
|
|
36
|
-
Anything in the repo that documents how code should be written, such as `CODING_STANDARDS.md` or `CONTRIBUTING.md`.
|
|
37
|
-
|
|
38
|
-
On top of whatever the repo documents, the Standards axis always carries the **smell baseline** below: a fixed set of Fowler code smells (_Refactoring_, ch.3) that applies even when a repo documents nothing. Two rules bind it:
|
|
39
|
-
|
|
40
|
-
- **The repo overrides.** A documented repo standard always wins; where it endorses something the baseline would flag, suppress the smell.
|
|
41
|
-
- **Always a judgement call.** Each smell is a labelled heuristic ("possible Feature Envy"), never a hard violation. Like any standard here, skip anything tooling already enforces.
|
|
42
|
-
|
|
43
|
-
Each smell reads *what it is* → *how to fix*; match it against the diff:
|
|
44
|
-
|
|
45
|
-
- **Mysterious Name**: a function, variable, or type whose name doesn't reveal what it does or holds. → rename it; if no honest name comes, the design's murky.
|
|
46
|
-
- **Duplicated Code**: the same logic shape appears in more than one hunk or file in the change. → extract the shared shape, call it from both.
|
|
47
|
-
- **Feature Envy**: a method that reaches into another object's data more than its own. → move the method onto the data it envies.
|
|
48
|
-
- **Data Clumps**: the same few fields or params keep travelling together (a type wanting to be born). → bundle them into one type, pass that.
|
|
49
|
-
- **Primitive Obsession**: a primitive or string standing in for a domain concept that deserves its own type. → give the concept its own small type.
|
|
50
|
-
- **Repeated Switches**: the same `switch`/`if`-cascade on the same type recurs across the change. → replace with polymorphism, or one map both sites share.
|
|
51
|
-
- **Shotgun Surgery**: one logical change forces scattered edits across many files in the diff. → gather what changes together into one module.
|
|
52
|
-
- **Divergent Change**: one file or module is edited for several unrelated reasons. → split so each module changes for one reason.
|
|
53
|
-
- **Speculative Generality**: abstraction, parameters, or hooks added for needs the spec doesn't have. → delete it; inline back until a real need shows.
|
|
54
|
-
- **Message Chains**: long `a.b().c().d()` navigation the caller shouldn't depend on. → hide the walk behind one method on the first object.
|
|
55
|
-
- **Middle Man**: a class or function that mostly just delegates onward. → cut it, call the real target direct.
|
|
56
|
-
- **Refused Bequest**: a subclass or implementer that ignores or overrides most of what it inherits. → drop the inheritance, use composition.
|
|
57
|
-
|
|
58
|
-
### 4. Spawn both sub-agents in parallel
|
|
59
|
-
|
|
60
|
-
**Standards sub-agent prompt** should include:
|
|
61
|
-
|
|
62
|
-
- The full diff command and commit list.
|
|
63
|
-
- The list of standards-source files you found in step 3, **plus the smell baseline from step 3** pasted in full (the sub-agent has no other access to it).
|
|
64
|
-
- The brief: "Report, per file/hunk where relevant, (a) every place the diff violates a documented standard: cite the standard (file + the rule); and (b) any baseline smell you spot: name it and quote the hunk. Distinguish hard violations from judgement calls: documented-standard breaches can be hard, but baseline smells are always judgement calls, and a documented repo standard overrides the baseline. Skip anything tooling enforces. Under 400 words."
|
|
65
|
-
|
|
66
|
-
**Spec sub-agent prompt** should include:
|
|
67
|
-
|
|
68
|
-
- The diff command and commit list.
|
|
69
|
-
- The path or fetched contents of the spec.
|
|
70
|
-
- The brief: "Report: (a) requirements the spec asked for that are missing or partial; (b) behaviour in the diff that wasn't asked for (scope creep); (c) requirements that look implemented but where the implementation looks wrong. Quote the spec line for each finding. Under 400 words."
|
|
71
|
-
|
|
72
|
-
If the spec is missing, skip the Spec sub-agent and note this in the final report.
|
|
73
|
-
|
|
74
|
-
### 5. Aggregate
|
|
75
|
-
|
|
76
|
-
Present the two reports under `## Standards` and `## Spec` headings, verbatim or lightly cleaned. Do **not** merge or rerank findings, because the two axes are deliberately separate (see _Why two axes_).
|
|
77
|
-
|
|
78
|
-
End with a one-line summary: total findings per axis, and the worst issue _within each axis_ (if any). Don't pick a single winner across axes: that's the reranking the separation exists to prevent.
|
|
79
|
-
|
|
80
|
-
## Why two axes
|
|
81
|
-
|
|
82
|
-
A change can pass one axis and fail the other:
|
|
83
|
-
|
|
84
|
-
- Code that follows every standard but implements the wrong thing → **Standards pass, Spec fail.**
|
|
85
|
-
- Code that does exactly what the issue asked but breaks the project's conventions → **Spec pass, Standards fail.**
|
|
86
|
-
|
|
87
|
-
Reporting them separately stops one axis from masking the other.
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
# Deepening
|
|
2
|
-
|
|
3
|
-
How to deepen a cluster of shallow modules safely, given its dependencies. Assumes the vocabulary in [SKILL.md](SKILL.md): **module**, **interface**, **seam**, **adapter**.
|
|
4
|
-
|
|
5
|
-
## Dependency categories
|
|
6
|
-
|
|
7
|
-
When assessing a candidate for deepening, classify its dependencies. The category determines how the deepened module is tested across its seam.
|
|
8
|
-
|
|
9
|
-
### 1. In-process
|
|
10
|
-
|
|
11
|
-
Pure computation, in-memory state, no I/O. Always deepenable: merge the modules and test through the new interface directly. No adapter needed.
|
|
12
|
-
|
|
13
|
-
### 2. Local-substitutable
|
|
14
|
-
|
|
15
|
-
Dependencies that have local test stand-ins (PGLite for Postgres, in-memory filesystem). Deepenable if the stand-in exists. The deepened module is tested with the stand-in running in the test suite. The seam is internal; no port at the module's external interface.
|
|
16
|
-
|
|
17
|
-
### 3. Remote but owned (Ports & Adapters)
|
|
18
|
-
|
|
19
|
-
Your own services across a network boundary (microservices, internal APIs). Define a **port** (interface) at the seam. The deep module owns the logic; the transport is injected as an **adapter**. Tests use an in-memory adapter. Production uses an HTTP/gRPC/queue adapter.
|
|
20
|
-
|
|
21
|
-
Recommendation shape: *"Define a port at the seam, implement an HTTP adapter for production and an in-memory adapter for testing, so the logic sits in one deep module even though it's deployed across a network."*
|
|
22
|
-
|
|
23
|
-
### 4. True external (Mock)
|
|
24
|
-
|
|
25
|
-
Third-party services (Stripe, Twilio, etc.) you don't control. The deepened module takes the external dependency as an injected port; tests provide a mock adapter.
|
|
26
|
-
|
|
27
|
-
## Seam discipline
|
|
28
|
-
|
|
29
|
-
- **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a port unless at least two adapters are justified (typically production + test). A single-adapter seam is just indirection.
|
|
30
|
-
- **Internal seams vs external seams.** A deep module can have internal seams (private to its implementation, used by its own tests) as well as the external seam at its interface. Don't expose internal seams through the interface just because tests use them.
|
|
31
|
-
|
|
32
|
-
## Testing strategy: replace, don't layer
|
|
33
|
-
|
|
34
|
-
- Old unit tests on shallow modules become waste once tests at the deepened module's interface exist; delete them.
|
|
35
|
-
- Write new tests at the deepened module's interface. The **interface is the test surface**.
|
|
36
|
-
- Tests assert on observable outcomes through the interface, not internal state.
|
|
37
|
-
- Tests should survive internal refactors, since they describe behaviour, not implementation. If a test has to change when the implementation changes, it's testing past the interface.
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
# Design It Twice
|
|
2
|
-
|
|
3
|
-
When the user wants to explore alternative interfaces for a chosen deepening candidate, use this parallel sub-agent pattern. Based on "Design It Twice" (Ousterhout): your first idea is unlikely to be the best.
|
|
4
|
-
|
|
5
|
-
Uses the vocabulary in [SKILL.md](SKILL.md): **module**, **interface**, **seam**, **adapter**, **leverage**.
|
|
6
|
-
|
|
7
|
-
## Process
|
|
8
|
-
|
|
9
|
-
### 1. Frame the problem space
|
|
10
|
-
|
|
11
|
-
Before spawning sub-agents, write a user-facing explanation of the problem space for the chosen candidate:
|
|
12
|
-
|
|
13
|
-
- The constraints any new interface would need to satisfy
|
|
14
|
-
- The dependencies it would rely on, and which category they fall into (see [DEEPENING.md](DEEPENING.md))
|
|
15
|
-
- A rough illustrative code sketch to ground the constraints, not a proposal, just a way to make the constraints concrete
|
|
16
|
-
|
|
17
|
-
Show this to the user, then immediately proceed to Step 2. The user reads and thinks while the sub-agents work in parallel.
|
|
18
|
-
|
|
19
|
-
### 2. Spawn sub-agents
|
|
20
|
-
|
|
21
|
-
Spawn 3+ sub-agents in parallel. Each must produce a **radically different** interface for the deepened module.
|
|
22
|
-
|
|
23
|
-
Prompt each sub-agent with a separate technical brief (file paths, coupling details, dependency category from [DEEPENING.md](DEEPENING.md), what sits behind the seam). The brief is independent of the user-facing problem-space explanation in Step 1. Give each agent a different design constraint:
|
|
24
|
-
|
|
25
|
-
- Agent 1: "Minimize the interface: aim for 1–3 entry points max. Maximise leverage per entry point."
|
|
26
|
-
- Agent 2: "Maximise flexibility: support many use cases and extension."
|
|
27
|
-
- Agent 3: "Optimise for the most common caller: make the default case trivial."
|
|
28
|
-
- Agent 4 (if applicable): "Design around ports & adapters for cross-seam dependencies."
|
|
29
|
-
|
|
30
|
-
Include both [SKILL.md](SKILL.md) vocabulary and CONTEXT.md vocabulary in the brief so each sub-agent names things consistently with the architecture language and the project's domain language.
|
|
31
|
-
|
|
32
|
-
Each sub-agent outputs:
|
|
33
|
-
|
|
34
|
-
1. Interface (types, methods, params, plus invariants, ordering, error modes)
|
|
35
|
-
2. Usage example showing how callers use it
|
|
36
|
-
3. What the implementation hides behind the seam
|
|
37
|
-
4. Dependency strategy and adapters (see [DEEPENING.md](DEEPENING.md))
|
|
38
|
-
5. Trade-offs: where leverage is high, where it's thin
|
|
39
|
-
|
|
40
|
-
### 3. Present and compare
|
|
41
|
-
|
|
42
|
-
Present designs sequentially so the user can absorb each one, then compare them in prose. Contrast by **depth** (leverage at the interface), **locality** (where change concentrates), and **seam placement**.
|
|
43
|
-
|
|
44
|
-
After comparing, give your own recommendation: which design you think is strongest and why. If elements from different designs would combine well, propose a hybrid. Be opinionated: the user wants a strong read, not a menu.
|
|
@@ -1,114 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: codebase-design
|
|
3
|
-
description: Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find deepening opportunities, decide where a seam goes, make code more testable or AI-navigable, or when another skill needs the deep-module vocabulary.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Codebase Design
|
|
7
|
-
|
|
8
|
-
Design **deep modules**: a lot of behaviour behind a small interface, placed at a clean seam, testable through that interface. Use this language and these principles wherever code is being designed or restructured. The aim is leverage for callers, locality for maintainers, and testability for everyone.
|
|
9
|
-
|
|
10
|
-
## Glossary
|
|
11
|
-
|
|
12
|
-
Use these terms exactly: don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point.
|
|
13
|
-
|
|
14
|
-
**Module**: anything with an interface and an implementation. Deliberately scale-agnostic: a function, class, package, or tier-spanning slice. _Avoid_: unit, component, service.
|
|
15
|
-
|
|
16
|
-
**Interface**: everything a caller must know to use the module correctly: the type signature, but also invariants, ordering constraints, error modes, required configuration, and performance characteristics. _Avoid_: API, signature (too narrow, they refer only to the type-level surface).
|
|
17
|
-
|
|
18
|
-
**Implementation**: what's inside a module, its body of code. Distinct from **Adapter**: a thing can be a small adapter with a large implementation (a Postgres repo) or a large adapter with a small implementation (an in-memory fake). Reach for "adapter" when the seam is the topic; "implementation" otherwise.
|
|
19
|
-
|
|
20
|
-
**Depth**: leverage at the interface. The amount of behaviour a caller (or test) can exercise per unit of interface they have to learn. A module is **deep** when a large amount of behaviour sits behind a small interface, **shallow** when the interface is nearly as complex as the implementation.
|
|
21
|
-
|
|
22
|
-
**Seam** _(Michael Feathers)_: a place where you can alter behaviour without editing in that place; the *location* at which a module's interface lives. Where to put the seam is its own design decision, distinct from what goes behind it. _Avoid_: boundary (overloaded with DDD's bounded context).
|
|
23
|
-
|
|
24
|
-
**Adapter**: a concrete thing that satisfies an interface at a seam. Describes *role* (what slot it fills), not substance (what's inside).
|
|
25
|
-
|
|
26
|
-
**Leverage**: what callers get from depth. More capability per unit of interface they learn. One implementation pays back across N call sites and M tests.
|
|
27
|
-
|
|
28
|
-
**Locality**: what maintainers get from depth. Change, bugs, knowledge, and verification concentrate in one place rather than spreading across callers. Fix once, fixed everywhere.
|
|
29
|
-
|
|
30
|
-
## Deep vs shallow
|
|
31
|
-
|
|
32
|
-
**Deep module** = small interface + lots of implementation:
|
|
33
|
-
|
|
34
|
-
```
|
|
35
|
-
┌─────────────────────┐
|
|
36
|
-
│ Small Interface │ ← Few methods, simple params
|
|
37
|
-
├─────────────────────┤
|
|
38
|
-
│ │
|
|
39
|
-
│ Deep Implementation│ ← Complex logic hidden
|
|
40
|
-
│ │
|
|
41
|
-
└─────────────────────┘
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
**Shallow module** = large interface + little implementation (avoid):
|
|
45
|
-
|
|
46
|
-
```
|
|
47
|
-
┌─────────────────────────────────┐
|
|
48
|
-
│ Large Interface │ ← Many methods, complex params
|
|
49
|
-
├─────────────────────────────────┤
|
|
50
|
-
│ Thin Implementation │ ← Just passes through
|
|
51
|
-
└─────────────────────────────────┘
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
When designing an interface, ask:
|
|
55
|
-
|
|
56
|
-
- Can I reduce the number of methods?
|
|
57
|
-
- Can I simplify the parameters?
|
|
58
|
-
- Can I hide more complexity inside?
|
|
59
|
-
|
|
60
|
-
## Principles
|
|
61
|
-
|
|
62
|
-
- **Depth is a property of the interface, not the implementation.** A deep module can be internally composed of small, mockable, swappable parts; they just aren't part of the interface. A module can have **internal seams** (private to its implementation, used by its own tests) as well as the **external seam** at its interface.
|
|
63
|
-
- **The deletion test.** Imagine deleting the module. If complexity vanishes, it was a pass-through. If complexity reappears across N callers, it was earning its keep.
|
|
64
|
-
- **The interface is the test surface.** Callers and tests cross the same seam. If you want to test *past* the interface, the module is probably the wrong shape.
|
|
65
|
-
- **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a seam unless something actually varies across it.
|
|
66
|
-
|
|
67
|
-
## Designing for testability
|
|
68
|
-
|
|
69
|
-
Good interfaces make testing natural:
|
|
70
|
-
|
|
71
|
-
1. **Accept dependencies, don't create them.**
|
|
72
|
-
|
|
73
|
-
```typescript
|
|
74
|
-
// Testable
|
|
75
|
-
function processOrder(order, paymentGateway) {}
|
|
76
|
-
|
|
77
|
-
// Hard to test
|
|
78
|
-
function processOrder(order) {
|
|
79
|
-
const gateway = new StripeGateway();
|
|
80
|
-
}
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
2. **Return results, don't produce side effects.**
|
|
84
|
-
|
|
85
|
-
```typescript
|
|
86
|
-
// Testable
|
|
87
|
-
function calculateDiscount(cart): Discount {}
|
|
88
|
-
|
|
89
|
-
// Hard to test
|
|
90
|
-
function applyDiscount(cart): void {
|
|
91
|
-
cart.total -= discount;
|
|
92
|
-
}
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
3. **Small surface area.** Fewer methods = fewer tests needed. Fewer params = simpler test setup.
|
|
96
|
-
|
|
97
|
-
## Relationships
|
|
98
|
-
|
|
99
|
-
- A **Module** has exactly one **Interface** (the surface it presents to callers and tests).
|
|
100
|
-
- **Depth** is a property of a **Module**, measured against its **Interface**.
|
|
101
|
-
- A **Seam** is where a **Module**'s **Interface** lives.
|
|
102
|
-
- An **Adapter** sits at a **Seam** and satisfies the **Interface**.
|
|
103
|
-
- **Depth** produces **Leverage** for callers and **Locality** for maintainers.
|
|
104
|
-
|
|
105
|
-
## Rejected framings
|
|
106
|
-
|
|
107
|
-
- **Depth as ratio of implementation-lines to interface-lines** (Ousterhout): rewards padding the implementation. We use depth-as-leverage instead.
|
|
108
|
-
- **"Interface" as the TypeScript `interface` keyword or a class's public methods**: too narrow: interface here includes every fact a caller must know.
|
|
109
|
-
- **"Boundary"**: overloaded with DDD's bounded context. Say **seam** or **interface**.
|
|
110
|
-
|
|
111
|
-
## Going deeper
|
|
112
|
-
|
|
113
|
-
- **Deepening a cluster given its dependencies**, see [DEEPENING.md](DEEPENING.md): dependency categories, seam discipline, and replace-don't-layer testing.
|
|
114
|
-
- **Exploring alternative interfaces**, see [DESIGN-IT-TWICE.md](DESIGN-IT-TWICE.md): spin up parallel sub-agents to design the interface several radically different ways, then compare on depth, locality, and seam placement.
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: diagnose-fix
|
|
3
|
-
description: "Complete diagnosis→fix→regression channel for bugs and performance regressions: diagnose, then fix behind observed red regression evidence. Functional bugs require a failing regression test; performance regressions may use a benchmark/perf harness with an explicit failing threshold. Use when the user says diagnose/debug/fix this, or reports something broken/throwing/failing/slow — prefer this over diagnosing-bugs when a fix is wanted, not just a diagnosis."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Diagnose Fix
|
|
7
|
-
|
|
8
|
-
本 skill 只连接诊断、受保护的最小修复和回归三个阶段。诊断细节以 [`diagnosing-bugs`](.agents/skills/diagnosing-bugs/SKILL.md) 为事实源,普通功能 bug 的红绿语义以 [`tdd`](.agents/skills/tdd/SKILL.md) 为事实源;不复制两个上游的完整步骤。
|
|
9
|
-
|
|
10
|
-
## 流程
|
|
11
|
-
|
|
12
|
-
### ① 诊断
|
|
13
|
-
|
|
14
|
-
委托 `diagnosing-bugs` 完成修复前的诊断活动:建立能捕捉用户症状的 tight feedback loop,实际复现并最小化,再形成可证伪的假设并按单变量探针验证。不要依赖固定 Phase 编号;以上游当前“进入修复前必须完成的诊断出口”为事实源。
|
|
15
|
-
|
|
16
|
-
出口:反馈回路已实际变红,最小复现已确认,且导致症状的假设已有证据;此阶段不写修复代码。
|
|
17
|
-
|
|
18
|
-
### ② 受保护的最小修复
|
|
19
|
-
|
|
20
|
-
先判断 Red 证据类型:
|
|
21
|
-
|
|
22
|
-
- **功能 bug**:在正确的公共 seam 上提出回归测试边界,遵循 `tdd` 要求获得用户确认;把最小复现转成失败回归测试并实际看到 Red,再写最小修复直到 Green。
|
|
23
|
-
- **性能回归**:复用 `diagnosing-bugs` 的 performance branch,建立可重复的 benchmark、timing harness、query-count 或 profiler-derived threshold;必须先实际观察到该阈值失败,再做最小修复,并用同一测量方式确认转绿。不为满足形式强造一个无法代表真实性能症状的普通单元测试。
|
|
24
|
-
|
|
25
|
-
**硬门槛:**不存在已实际观察到的 **red-capable regression evidence** 时,不得写修复代码。功能 bug 的证据必须是正确 seam 上的失败回归测试;性能回归可使用带明确阈值且可重复的 benchmark/perf harness。不存在正确 seam 或可靠性能测量边界时,本身就是 finding;记录阻塞,不绕过证据直接修改。
|
|
26
|
-
|
|
27
|
-
出口:功能 bug 为 regression test Red → 最小修复 → Green;性能回归为 benchmark/perf threshold Red → 最小修复 → Green。两者都不进入 `tdd-implement` 的长流程。
|
|
28
|
-
|
|
29
|
-
### ③ 回归收尾
|
|
30
|
-
|
|
31
|
-
按 `diagnosing-bugs` 的收尾要求重跑阶段 ① 的原始、未最小化反馈回路,确认用户症状消失;功能 bug 重跑回归测试,性能回归重跑原始基准/测量;清理 `[DEBUG-...]` 探针和一次性 harness,并记录最终验证的假设。
|
|
32
|
-
|
|
33
|
-
出口:原始症状消失、对应 regression evidence 为 Green、临时诊断产物已清理。
|
|
34
|
-
|
|
35
|
-
## 回合连续性
|
|
36
|
-
|
|
37
|
-
诊断 → Red 证据 → 修复 → Green → 原始回路 → 清理在一个回合内连续推进。只有功能 bug 的 seam 确认、发现无正确 seam/测量边界、外部环境阻塞或整个阶段出口可以暂停;预告下一步后立即执行。
|
|
38
|
-
|
|
39
|
-
## 引用
|
|
40
|
-
|
|
41
|
-
- 诊断与性能分支:[`diagnosing-bugs`](.agents/skills/diagnosing-bugs/SKILL.md)
|
|
42
|
-
- 功能 bug 修复:[`tdd`](.agents/skills/tdd/SKILL.md)
|
|
43
|
-
- 负向边界:[`references/anti-patterns.md`](references/anti-patterns.md)
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# 反模式清单(Diagnose-Fix)
|
|
2
|
-
|
|
3
|
-
SKILL.md 正文各阶段规则是正面约束;本文件是负向边界(不做什么),为细节唯一出处。SKILL.md 只引用本文件,不重复内容。
|
|
4
|
-
|
|
5
|
-
## 诊断阶段
|
|
6
|
-
|
|
7
|
-
- 不跳过反馈回路直接猜根因:回路未红之前不进入假设、不写修复代码
|
|
8
|
-
- 功能 bug 不把最小复现永久留在 harness 里:必须转写为正确 seam 上的回归测试;性能回归可保留最小、可重复且有明确阈值的 benchmark/perf harness 作为回归证据
|
|
9
|
-
- 不一次改多个变量:探针一次只改一个,`[DEBUG-...]` 前缀标记
|
|
10
|
-
|
|
11
|
-
## 修复阶段
|
|
12
|
-
|
|
13
|
-
- 不绕过 red-capable regression evidence 直接改代码——功能 bug 没有正确 seam 是 finding;性能回归没有可靠测量边界同样是 finding,不是豁免
|
|
14
|
-
- 不为性能问题强造一个不能代表真实慢路径的普通单元测试;优先复用 diagnosis 中已经验证过的 benchmark、timing、query-count 或 profiler-derived threshold
|
|
15
|
-
- 不套用 tdd-implement 重流程:单个 bug/perf regression 的修复保持轻量,不引入完整 delivery orchestration
|
|
16
|
-
- 不重写 tdd 技能的红-绿语义:功能 bug 的 seam 定义、好测试标准、mocking 边界一律查上游技能
|
|
17
|
-
|
|
18
|
-
## 回归阶段
|
|
19
|
-
|
|
20
|
-
- 不遗留探针:`[DEBUG-...]` 前缀的临时改动在回归验证后全部清理
|
|
21
|
-
- 不跳过原始反馈回路的重跑:最小化场景绿 ≠ 原始症状消失
|
|
@@ -1,138 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: diagnosing-bugs
|
|
3
|
-
description: Diagnosis loop for hard bugs and performance regressions. Use when the user says "diagnose"/"debug this", or reports something broken/throwing/failing/slow.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Diagnosing Bugs
|
|
7
|
-
|
|
8
|
-
A discipline for hard bugs. Skip phases only when explicitly justified.
|
|
9
|
-
|
|
10
|
-
When exploring the codebase, read `CONTEXT.md` (if it exists) to get a clear mental model of the relevant modules, and check ADRs in the area you're touching.
|
|
11
|
-
|
|
12
|
-
## Redact
|
|
13
|
-
|
|
14
|
-
This skill has you show commands, outputs and captured artifacts. **Redact every secret first**: write `<REDACTED>` in its place. Build loops against env vars, so the credential stays in the environment rather than in what you show. Captured artifacts carry auth headers: quote only the lines that carry the signal.
|
|
15
|
-
|
|
16
|
-
If the redacted output is not enough to diagnose the bug, say so and ask the user.
|
|
17
|
-
|
|
18
|
-
## Phase 1: Build a feedback loop
|
|
19
|
-
|
|
20
|
-
**This is the skill.** Everything else is mechanical. If you have a **tight** pass/fail signal for the bug (one that goes red on _this_ bug), you will find the cause; bisection, hypothesis-testing, and instrumentation all just consume it. If you don't have one, no amount of staring at code will save you.
|
|
21
|
-
|
|
22
|
-
Spend disproportionate effort here. **Be aggressive. Be creative. Refuse to give up.**
|
|
23
|
-
|
|
24
|
-
### Ways to construct one, in roughly this order
|
|
25
|
-
|
|
26
|
-
1. **Failing test** at whatever seam reaches the bug: unit, integration, e2e.
|
|
27
|
-
2. **Curl / HTTP script** against a running dev server.
|
|
28
|
-
3. **CLI invocation** with a fixture input, diffing stdout against a known-good snapshot.
|
|
29
|
-
4. **Headless browser script** (Playwright / Puppeteer) that drives the UI and asserts on DOM/console/network.
|
|
30
|
-
5. **Replay a captured trace.** Save a real network request / payload / event log to disk; replay it through the code path in isolation.
|
|
31
|
-
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.
|
|
32
|
-
7. **Property / fuzz loop.** If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
|
|
33
|
-
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.
|
|
34
|
-
9. **Differential loop.** Run the same input through old-version vs new-version (or two configs) and diff outputs.
|
|
35
|
-
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.
|
|
36
|
-
|
|
37
|
-
Build the right feedback loop, and the bug is 90% fixed.
|
|
38
|
-
|
|
39
|
-
### Tighten the loop
|
|
40
|
-
|
|
41
|
-
Treat the loop as a product. Once you have _a_ loop, **tighten** it:
|
|
42
|
-
|
|
43
|
-
- Can I make it faster? (Cache setup, skip unrelated init, narrow the test scope.)
|
|
44
|
-
- Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
|
|
45
|
-
- Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)
|
|
46
|
-
|
|
47
|
-
A 30-second flaky loop is barely better than no loop; a 2-second deterministic one is tight, a debugging superpower.
|
|
48
|
-
|
|
49
|
-
### Non-deterministic bugs
|
|
50
|
-
|
|
51
|
-
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, so keep raising the rate until it's debuggable.
|
|
52
|
-
|
|
53
|
-
### When you genuinely cannot build a loop
|
|
54
|
-
|
|
55
|
-
Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a redacted 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.
|
|
56
|
-
|
|
57
|
-
### Completion criterion: a tight loop that goes red
|
|
58
|
-
|
|
59
|
-
Phase 1 is done when the loop is **tight** and **red-capable**: you can name **one command** (a script path, a test invocation, a curl) that you have **already run at least once** (show the invocation and its output, redacted), and that is:
|
|
60
|
-
|
|
61
|
-
- [ ] **Red-capable**: it drives the actual bug code path and asserts the **user's exact symptom**, so it can go red on this bug and green once fixed. Not "runs without erroring"; it must be able to _catch this specific bug_.
|
|
62
|
-
- [ ] **Deterministic**: same verdict every run (flaky bugs: a pinned, high reproduction rate, per above).
|
|
63
|
-
- [ ] **Fast**: seconds, not minutes.
|
|
64
|
-
- [ ] **Agent-runnable**: you can run it unattended; a human in the loop only via `scripts/hitl-loop.template.sh`.
|
|
65
|
-
|
|
66
|
-
If you catch yourself reading code to build a theory before this command exists, **stop: jumping straight to a hypothesis is the exact failure this skill prevents.** No red-capable command, no Phase 2.
|
|
67
|
-
|
|
68
|
-
## Phase 2: Reproduce + minimise
|
|
69
|
-
|
|
70
|
-
Run the loop. Watch it go red as the bug appears.
|
|
71
|
-
|
|
72
|
-
Confirm:
|
|
73
|
-
|
|
74
|
-
- [ ] The loop produces the failure mode the **user** described, not a different failure that happens to be nearby. Wrong bug = wrong fix.
|
|
75
|
-
- [ ] The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
|
|
76
|
-
- [ ] You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.
|
|
77
|
-
|
|
78
|
-
### Minimise
|
|
79
|
-
|
|
80
|
-
Once it's red, shrink the repro to the **smallest scenario that still goes red**. Cut inputs, callers, config, data, and steps **one at a time**, re-running the loop after each cut, and keep only what's load-bearing for the failure.
|
|
81
|
-
|
|
82
|
-
Why bother: a minimal repro shrinks the hypothesis space in Phase 3 (fewer moving parts left to suspect) and becomes the clean regression test in Phase 5.
|
|
83
|
-
|
|
84
|
-
Done when **every remaining element is load-bearing**: removing any one of them makes the loop go green.
|
|
85
|
-
|
|
86
|
-
Do not proceed until you have reproduced **and** minimised.
|
|
87
|
-
|
|
88
|
-
## Phase 3: Hypothesise
|
|
89
|
-
|
|
90
|
-
Generate **3–5 ranked hypotheses** before testing any of them. Single-hypothesis generation anchors on the first plausible idea.
|
|
91
|
-
|
|
92
|
-
Each hypothesis must be **falsifiable**: state the prediction it makes.
|
|
93
|
-
|
|
94
|
-
> Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."
|
|
95
|
-
|
|
96
|
-
If you cannot state the prediction, the hypothesis is a vibe: discard or sharpen it.
|
|
97
|
-
|
|
98
|
-
**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.
|
|
99
|
-
|
|
100
|
-
## Phase 4: Instrument
|
|
101
|
-
|
|
102
|
-
Each probe must map to a specific prediction from Phase 3. **Change one variable at a time.**
|
|
103
|
-
|
|
104
|
-
Tool preference:
|
|
105
|
-
|
|
106
|
-
1. **Debugger / REPL inspection** if the env supports it. One breakpoint beats ten logs.
|
|
107
|
-
2. **Targeted logs** at the boundaries that distinguish hypotheses.
|
|
108
|
-
3. Never "log everything and grep".
|
|
109
|
-
|
|
110
|
-
**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.
|
|
111
|
-
|
|
112
|
-
**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.
|
|
113
|
-
|
|
114
|
-
## Phase 5: Fix + regression test
|
|
115
|
-
|
|
116
|
-
Write the regression test **before the fix**, but only if there is a **correct seam** for it.
|
|
117
|
-
|
|
118
|
-
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.
|
|
119
|
-
|
|
120
|
-
**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.
|
|
121
|
-
|
|
122
|
-
If a correct seam exists:
|
|
123
|
-
|
|
124
|
-
1. Turn the minimised repro into a failing test at that seam.
|
|
125
|
-
2. Watch it fail.
|
|
126
|
-
3. Apply the fix.
|
|
127
|
-
4. Watch it pass.
|
|
128
|
-
5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.
|
|
129
|
-
|
|
130
|
-
## Phase 6: Cleanup
|
|
131
|
-
|
|
132
|
-
Required before declaring done:
|
|
133
|
-
|
|
134
|
-
- [ ] Original repro no longer reproduces (re-run the Phase 1 loop)
|
|
135
|
-
- [ ] Regression test passes (or absence of seam is documented)
|
|
136
|
-
- [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
|
|
137
|
-
- [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
|
|
138
|
-
- [ ] The hypothesis that turned out correct is stated in the commit / PR message, so the next debugger learns
|