@heihei0299/matt-skills 1.3.1 → 1.3.3
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/.agents/skills/ask-matt/PHASE-BOUNDARIES.md +55 -0
- package/.agents/skills/ask-matt/SKILL.md +37 -25
- package/.agents/skills/ci-guard/SKILL.md +104 -0
- package/.agents/skills/ci-guard/agents/openai.yaml +5 -0
- package/.agents/skills/code-review/SKILL.md +28 -35
- package/.agents/skills/codebase-design/DEEPENING.md +4 -4
- package/.agents/skills/codebase-design/DESIGN-IT-TWICE.md +10 -10
- package/.agents/skills/codebase-design/SKILL.md +13 -13
- package/.agents/skills/diagnosing-bugs/SKILL.md +34 -30
- package/.agents/skills/diagnosing-bugs/scripts/hitl-loop.template.sh +3 -0
- package/.agents/skills/domain-modeling/ADR-FORMAT.md +11 -11
- package/.agents/skills/domain-modeling/CONTEXT-FORMAT.md +3 -3
- package/.agents/skills/domain-modeling/SKILL.md +10 -10
- package/.agents/skills/grill-me/SKILL.md +1 -1
- package/.agents/skills/grill-with-docs/SKILL.md +1 -1
- package/.agents/skills/grilling/SKILL.md +20 -4
- package/.agents/skills/grilling/agents/openai.yaml +1 -1
- package/.agents/skills/handoff/SKILL.md +1 -1
- package/.agents/skills/improve-codebase-architecture/HTML-REPORT.md +19 -19
- package/.agents/skills/improve-codebase-architecture/SKILL.md +21 -21
- package/.agents/skills/instance-test/SKILL.md +36 -27
- package/.agents/skills/instance-test/agents/openai.yaml +1 -1
- package/.agents/skills/instance-test/references/instances.md +63 -36
- package/.agents/skills/prototype/LOGIC.md +30 -42
- package/.agents/skills/prototype/SKILL.md +7 -7
- package/.agents/skills/prototype/UI.md +23 -23
- package/.agents/skills/research/SKILL.md +1 -1
- package/.agents/skills/resolving-merge-conflicts/SKILL.md +1 -1
- package/.agents/skills/scaffold-functional-test/SKILL.md +77 -0
- package/.agents/skills/scaffold-functional-test/agents/openai.yaml +5 -0
- package/.agents/skills/setup-matt-pocock-skills/SKILL.md +30 -30
- package/.agents/skills/setup-matt-pocock-skills/domain.md +4 -4
- package/.agents/skills/setup-matt-pocock-skills/issue-tracker-github.md +5 -5
- package/.agents/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +6 -6
- package/.agents/skills/setup-matt-pocock-skills/issue-tracker-local.md +3 -3
- package/.agents/skills/tdd/SKILL.md +9 -7
- package/.agents/skills/teach/GLOSSARY-FORMAT.md +3 -3
- package/.agents/skills/teach/LEARNING-RECORD-FORMAT.md +10 -10
- package/.agents/skills/teach/MISSION-FORMAT.md +4 -4
- package/.agents/skills/teach/RESOURCES-FORMAT.md +2 -2
- package/.agents/skills/teach/SKILL.md +4 -4
- package/.agents/skills/to-questionnaire/SKILL.md +54 -0
- package/.agents/skills/to-questionnaire/agents/openai.yaml +5 -0
- package/.agents/skills/to-spec/SKILL.md +4 -4
- package/.agents/skills/to-tickets/SKILL.md +16 -16
- package/.agents/skills/triage/AGENT-BRIEF.md +9 -9
- package/.agents/skills/triage/OUT-OF-SCOPE.md +15 -15
- package/.agents/skills/triage/SKILL.md +29 -29
- package/.agents/skills/wait-what/SKILL.md +7 -0
- package/.agents/skills/wait-what/agents/openai.yaml +5 -0
- package/.agents/skills/wayfinder/SKILL.md +37 -37
- package/.agents/skills/wizard/SKILL.md +44 -0
- package/.agents/skills/wizard/agents/openai.yaml +3 -0
- package/.agents/skills/wizard/template.sh +204 -0
- package/.agents/skills/writing-for-agents/SKILL-MECHANICS.md +22 -0
- package/.agents/skills/writing-for-agents/SKILL.md +81 -0
- package/.agents/skills/writing-for-agents/agents/openai.yaml +3 -0
- package/README.md +9 -9
- package/bin/cli.js +1 -1
- package/config/proprietary.json +8 -1
- package/package.json +1 -1
- package/scripts/sync-upstream.js +1 -1
- package/template/.opencode/CONTEXT.md +2 -2
- package/template/.opencode/commands/{writing-great-skills.md → writing-for-agents.md} +1 -1
- package/template/.opencode/docs/agents/skill-design.md +3 -3
- package/template/.opencode/skills/ci-guard/SKILL.md +104 -0
- package/template/.opencode/skills/ci-guard/agents/openai.yaml +5 -0
- package/template/.opencode/skills/scaffold-functional-test/SKILL.md +77 -0
- package/template/.opencode/skills/scaffold-functional-test/agents/openai.yaml +5 -0
- package/template/.pi/CONTEXT.md +55 -0
- package/template/.pi/docs/agents/runtime-discipline.md +3 -2
- package/template/.pi/docs/agents/skill-design.md +10 -5
- package/template/.pi/skills/ci-guard/SKILL.md +104 -0
- package/template/.pi/skills/ci-guard/agents/openai.yaml +5 -0
- package/template/.pi/skills/scaffold-functional-test/SKILL.md +77 -0
- package/template/.pi/skills/scaffold-functional-test/agents/openai.yaml +5 -0
- package/template/AGENTS.md +3 -4
- package/.agents/skills/writing-great-skills/GLOSSARY.md +0 -201
- package/.agents/skills/writing-great-skills/SKILL.md +0 -83
- package/.agents/skills/writing-great-skills/agents/openai.yaml +0 -5
- package/template/.opencode/skills/instance-test/SKILL.md +0 -61
- package/template/.opencode/skills/instance-test/agents/openai.yaml +0 -5
- package/template/.opencode/skills/instance-test/references/instances.md +0 -48
- package/template/.pi/skills/instance-test/SKILL.md +0 -61
- package/template/.pi/skills/instance-test/agents/openai.yaml +0 -5
- package/template/.pi/skills/instance-test/references/instances.md +0 -48
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Phase boundaries
|
|
2
|
+
|
|
3
|
+
A **phase** is a chunk of work inside a session: the grilling, the implementation, the QA. The definition is fuzzy on purpose: a phase ends when you think *"ok, we're done with that"*.
|
|
4
|
+
|
|
5
|
+
The **phase boundary** is the gap between two phases, and it is the only place this decision belongs. Mid-phase there is no decision to make: continue, or split the work that's left into subagents. Compacting mid-phase makes the agent lose the thread.
|
|
6
|
+
|
|
7
|
+
## The five options
|
|
8
|
+
|
|
9
|
+
| Option | What it does |
|
|
10
|
+
| ------------ | --------------------------------------------------------------- |
|
|
11
|
+
| **Continue** | Stay in the session. No context switch at all. |
|
|
12
|
+
| **`/clear`** | Empty the context window and start from nothing. |
|
|
13
|
+
| **`/handoff`** | Write a portable markdown file and seed a session anywhere with it. |
|
|
14
|
+
| **Subagent** | Send the task to its own context window and get a report back. |
|
|
15
|
+
| **`/compact`** | Compress this context and seed a fresh session with the summary. |
|
|
16
|
+
|
|
17
|
+
## The tree
|
|
18
|
+
|
|
19
|
+
Work top to bottom at the boundary. The first **yes** wins.
|
|
20
|
+
|
|
21
|
+
**1. Can you continue in this session?** Two things make the answer yes: the next phase needs this phase as a **primary source**, or you have enough [smart zone](https://www.aihero.dev/ai-coding-dictionary/smart-zone) left (~150k tokens) for the next phase to fit. Grilling → implementation is the standard yes: the implementation wants the reasoning verbatim, not a summary of it. Continue costs nothing and loses nothing, so rule it out before anything else.
|
|
22
|
+
|
|
23
|
+
**2. Is the context irrelevant to what comes next?** Is everything in this session (the exploration, the decisions, the dead ends) disposable? If so, **`/clear`**. It is the cheapest move on the board: it takes no time and hands back the whole window. `/clear` also isn't terminal: the old session stays resumable.
|
|
24
|
+
|
|
25
|
+
The cost of getting this wrong is one-way. Clear a *relevant* context and you lose the **why** behind what you built, and no amount of reading the diff back gets it returned.
|
|
26
|
+
|
|
27
|
+
**3. Do you need to hand off?** `/handoff` is narrow. You need it only when you are:
|
|
28
|
+
|
|
29
|
+
- swapping to a **new harness** (Claude → Codex),
|
|
30
|
+
- moving to a **new directory** or repo,
|
|
31
|
+
- sending the work to a **colleague**,
|
|
32
|
+
- or forking a side task you found **mid-phase** without derailing what you're doing.
|
|
33
|
+
|
|
34
|
+
That list is the whole clause. What `/handoff` buys is **portability**: a file that travels. If nothing is travelling, you don't need it.
|
|
35
|
+
|
|
36
|
+
**4. Can the task be done AFK?** Is it scoped tightly enough to run with you away from the keyboard, no steering? Then send it to a **subagent** and leave this session untouched. Automated review is the standard case: the agent reads the diff and reports, and you aren't needed while it does.
|
|
37
|
+
|
|
38
|
+
**5. Otherwise, `/compact`.** Relevant context, same harness, same directory, and you need to stay in the loop: this is where the tree lands, and it lands here often. Pass it an instruction (`/compact we're going to QA this area`) so the summary keeps what the next phase needs.
|
|
39
|
+
|
|
40
|
+
`/compact` is the **default, not the first reach**. It sits at the bottom because the four questions above it are all cheaper or more precise. The failure mode when people start here is a fresh session that is confidently wrong about a decision the summary flattened.
|
|
41
|
+
|
|
42
|
+
## Primary and secondary sources
|
|
43
|
+
|
|
44
|
+
Every move except **Continue** turns a **primary source** into a **secondary source**: the session as it happened, replaced by a summary of it. The trade is always the same shape:
|
|
45
|
+
|
|
46
|
+
| Source | Information | Noise | Room to move |
|
|
47
|
+
| --------------------------------- | ----------- | ----- | ------------ |
|
|
48
|
+
| Primary (Continue) | Full | Lots | Little |
|
|
49
|
+
| Secondary (`/compact`, `/handoff`) | Lossy | Less | Lots |
|
|
50
|
+
|
|
51
|
+
This is why question 1 comes first. You only pay the lossiness when staying costs more than it saves.
|
|
52
|
+
|
|
53
|
+
## These are judgement calls
|
|
54
|
+
|
|
55
|
+
The questions are not objective: each has taste in it, and the same boundary can go two ways on two days. The value is in asking them **in order**, at the boundary rather than in the middle of the work.
|
|
@@ -14,22 +14,22 @@ A **flow** is a path through the skills. Most paths run along one **main flow**,
|
|
|
14
14
|
|
|
15
15
|
The route most work travels. You have an idea and want it built.
|
|
16
16
|
|
|
17
|
-
1. **`/grill-with-docs`**
|
|
18
|
-
2. **Branch
|
|
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
19
|
- **`/handoff`** out, then open a fresh session against that file,
|
|
20
20
|
- **`/prototype`** to answer the question with throwaway code,
|
|
21
21
|
- **`/handoff`** back what you learned, and reference it from the original idea thread.
|
|
22
|
-
3. **Branch
|
|
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
|
|
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
24
|
- **No** → **`/implement`** right here, in the same context window.
|
|
25
25
|
|
|
26
|
-
Either way, **`/implement`** builds each issue by driving **`/tdd`** internally
|
|
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
27
|
|
|
28
28
|
### Context hygiene
|
|
29
29
|
|
|
30
|
-
Keep steps 1–3 in **one unbroken context window**
|
|
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
31
|
|
|
32
|
-
The limit on this is the **[smart zone](https://www.aihero.dev/ai-coding-dictionary/smart-zone)**: the window (~
|
|
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
33
|
|
|
34
34
|
## On-ramps
|
|
35
35
|
|
|
@@ -37,42 +37,54 @@ A starting situation that generates work, then merges onto the main flow.
|
|
|
37
37
|
|
|
38
38
|
- **Bugs and requests piling up** → **`/triage`**. It moves issues through triage roles and produces agent-ready issues, which **`/implement`** later picks up.
|
|
39
39
|
|
|
40
|
-
Triage is only for issues **you didn't create
|
|
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
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**
|
|
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
43
|
|
|
44
|
-
- **A huge, foggy effort
|
|
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
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
|
|
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
47
|
|
|
48
48
|
## Codebase health
|
|
49
49
|
|
|
50
|
-
Not feature work
|
|
50
|
+
Not feature work, just upkeep.
|
|
51
51
|
|
|
52
|
-
- **`/improve-codebase-architecture`**
|
|
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
53
|
|
|
54
54
|
## Vocabulary underneath
|
|
55
55
|
|
|
56
|
-
Two model-invoked references that run *beneath* the other skills
|
|
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
57
|
|
|
58
|
-
- **`/domain-modeling
|
|
59
|
-
- **`/codebase-design`**
|
|
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
60
|
|
|
61
|
-
##
|
|
61
|
+
## Phase boundaries
|
|
62
62
|
|
|
63
|
-
|
|
64
|
-
|
|
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.
|
|
65
72
|
|
|
66
73
|
## Standalone
|
|
67
74
|
|
|
68
75
|
Off the main flow entirely.
|
|
69
76
|
|
|
70
|
-
- **`/grill-me
|
|
71
|
-
- **`/
|
|
72
|
-
- **`/
|
|
73
|
-
- **`/
|
|
74
|
-
- **`/
|
|
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.
|
|
75
87
|
|
|
76
88
|
## Precondition
|
|
77
89
|
|
|
78
|
-
**`/setup-matt-pocock-skills
|
|
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.
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ci-guard
|
|
3
|
+
description: "Guard the GitHub Actions release pipeline: orchestrate workflow flow, enforce pre-release verification, and self-correct after publish. Use when CI is flaky/failing, when setting up or editing .github/workflows/ci.yml, or before tagging a release to npm."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# CI Guard
|
|
7
|
+
|
|
8
|
+
**guard** 为领衔词的发布门禁技能:以一次**可复现的失败**为起点,把 `verify → build → publish` 编排成不可绕过的门,把**预发布校验**做成硬门槛,把**发布后自纠**做成闭环。本技能沉淀自 `heihei0299/pi-switch` 23 次运行中 14 次失败的复盘(见 `.scratch/research/ci-actions-调研.md`)——不替代 `diagnose-fix` 的通用诊断,只收敛 CI/发布这一条链。
|
|
9
|
+
|
|
10
|
+
## 何时用
|
|
11
|
+
|
|
12
|
+
- Actions 持续红 / 偶发红(尤其是 `verify` 单点红而 `publish` 仍绿)
|
|
13
|
+
- 新建或改动 `.github/workflows/ci.yml`、调整 `cargo test` / `clippy` / `rustfmt` 参数
|
|
14
|
+
- 打 tag 前、发 npm 前、或发布后需要自检/回滚
|
|
15
|
+
|
|
16
|
+
## 三段式门禁
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
① 编排 flows → ② 预发布 gate → ③ 发布后自纠
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
每段有**完成条件**(可验证),未满足不进入下一段。
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
### ① 编排 flows —— 让工作流不可被绕过
|
|
27
|
+
|
|
28
|
+
**做**:
|
|
29
|
+
- `on`:`push.tags: ["v*"]` **必须**同时配 `push.branches: [main]`(或 `master`)+ `pull_request.branches: [main]` + `workflow_dispatch`。否则直推 `main` 的修复(如 `2d68f62`)无法被 CI 验证,tag 才暴露问题
|
|
30
|
+
- `jobs` 依赖:`publish.needs: [build, verify]`,**禁止** `needs: build` 单依赖。门禁失效的直接原因就是 `verify` 红仍发包
|
|
31
|
+
- `permissions` 最小化:`verify`/`build` 只需 `contents: read`,仅 `publish` 保留 `contents: write` + `packages: write`(或 `id-token: write` 若用 OIDC)
|
|
32
|
+
- `concurrency`:`group: ci-${{ github.ref }}` + `cancel-in-progress: true`,避免同分支并行互踩
|
|
33
|
+
- `cache`:`rust-cache` 或 `actions/cache` 缓存 `~/.cargo` + `target`,`actions/setup-node` 加 `cache: npm`,避免每次 `npm install` 重装
|
|
34
|
+
- `find changed Rust files`:`git diff origin/main...HEAD` 在 tag 事件下为空,改为 `git diff --name-only HEAD~1...HEAD` 或直接全量 `cargo fmt --check` / `clippy`,避免误跳过
|
|
35
|
+
|
|
36
|
+
**完成条件**:
|
|
37
|
+
- [ ] `git diff HEAD -- .github/workflows/ci.yml` 显示 `on.push.branches` 存在
|
|
38
|
+
- [ ] `publish.needs` 包含 `verify`
|
|
39
|
+
- [ ] `workflow_dispatch` 可手动触发全量
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
### ② 预发布 gate —— 在写盘之前变红
|
|
44
|
+
|
|
45
|
+
本段是**硬门槛**,顺序固定:`fmt → clippy → test → build`,任一步红即阻断 `publish`。
|
|
46
|
+
|
|
47
|
+
**fmt / clippy**:
|
|
48
|
+
- `rustfmt --check` 与 `cargo clippy --all-targets -- -D warnings` 必须与本地一致(`rust-toolchain.toml` 锁定 `stable` 版本)
|
|
49
|
+
- 允许的 `-A` 必须显式列出(如本仓 `-A clippy::manual_checked_ops` 等 4 项),不批量 `-A clippy::all`
|
|
50
|
+
|
|
51
|
+
**test(关键)**:
|
|
52
|
+
- 落盘测试(如 `web::tests` 直写 `config.json` / `models.json`)**必须**测试隔离:`config_dir()` / `pi_dir()` / `models_path()` 在 `#[cfg(test)]` 下重定向到 `temp/pi-switch-test-<pid>`(参考 `src-rust/proxy.rs:115 init_test_state_dir()`,`config.rs:460` 为未隔离反例;曾用 `PI_SWITCH_CONFIG_DIR` 环境覆盖后被 `20f6f86` 误删,即回归)
|
|
53
|
+
- 若暂未隔离,CI 侧以 `cargo test --release --lib -- --test-threads=1` 串行化为**过渡**(`2d68f62` 方案,322/322 稳定),并在代码侧记录 `TODO(ci-guard): 恢复 config_dir 测试隔离后去掉 --test-threads=1`
|
|
54
|
+
- `verify` 必须跑 `cargo test --lib`(或 `--release --lib` 与发布一致),不跳过;`build` 矩阵 5 目标仅验编译,不代验测试
|
|
55
|
+
|
|
56
|
+
**完成条件**:
|
|
57
|
+
- [ ] 本地 `cargo test --lib -- --test-threads=1` 322/322 且 `cargo test --lib`(并行)亦 322/322 或已记录隔离 TODO
|
|
58
|
+
- [ ] `cargo clippy --all-targets` 0 warning
|
|
59
|
+
- [ ] `npm run build:webui` 在 `verify` 与 `build` 均执行(本仓 WebUI 缺失会导致 `publish` 产物不一致)
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
### ③ 发布后自纠 —— 发出去的包自己负责
|
|
64
|
+
|
|
65
|
+
**发布时**:
|
|
66
|
+
- `npm publish --access public` 仅在 `if: startsWith(github.ref, 'refs/tags/v')` 且 `needs` 全绿时执行
|
|
67
|
+
- 发布前 `actions/download-artifact` 校验 `if-no-files-found: error`,发布后 `npm view <pkg>@<version> version` 回读确认
|
|
68
|
+
|
|
69
|
+
**自纠**:
|
|
70
|
+
- 失败即 **阻断**:`verify` 红 → `publish` 不执行(由 `needs` 保证);`publish` 自身失败(`409 already exists` / `401`)→ 工作流整体 `failure`,不静默
|
|
71
|
+
- 发布后 30s 内 `curl https://registry.npmjs.org/<pkg>/<version>` 校验可用;失败则 `gh issue create --title "chore(release): vX.Y.Z 发布后自检失败" --body "run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"` 并 `gh release delete vX.Y.Z --yes`(或 `npm unpublish <pkg>@<version>` 在 72h 内)
|
|
72
|
+
- `workflow_dispatch` 支持 `inputs.rollback_version` 手动回滚
|
|
73
|
+
|
|
74
|
+
**完成条件**:
|
|
75
|
+
- [ ] `npm view` 回读与 tag 一致
|
|
76
|
+
- [ ] 失败路径有 issue/通知(非静默)
|
|
77
|
+
- [ ] `git tag` 与 `package.json version` 一致(`scripts/release.sh` 或 `npm version` 保证)
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## 反模式
|
|
82
|
+
|
|
83
|
+
- **单依赖 publish**:`needs: build` 是本仓 7 次带病发布的根因
|
|
84
|
+
- **仅 tag 触发**:`push.branches` 缺失导致主干修复无 CI
|
|
85
|
+
- **真实落盘并行测试**:无 `#[cfg(test)]` 隔离的 `config_dir` 直写是偶发红的根因,`--test-threads=1` 只是止血
|
|
86
|
+
- **静默发布**:`publish` 失败不建 issue / 不删 tag,下次 `409` 叠加
|
|
87
|
+
- **`-A clippy::all`**:掩盖真实告警
|
|
88
|
+
|
|
89
|
+
## 引用
|
|
90
|
+
|
|
91
|
+
- 调研:`.scratch/research/ci-actions-调研.md`(23 次运行全量、`proxy.rs:115` vs `config.rs:460` 对比)
|
|
92
|
+
- 修复:`2d68f62 fix(ci): gate publish on verify and serialize Rust tests`
|
|
93
|
+
- 关联技能:`diagnose-fix`(通用诊断)、`commit-check`(提交前门禁)、`tdd`(测试隔离后的回归)
|
|
94
|
+
|
|
95
|
+
## 执行清单(粘贴即用)
|
|
96
|
+
|
|
97
|
+
```markdown
|
|
98
|
+
- [ ] .github/workflows/ci.yml: on.push.branches: [main] 已加
|
|
99
|
+
- [ ] publish.needs: [build, verify]
|
|
100
|
+
- [ ] verify: cargo test --release --lib -- --test-threads=1(或已隔离则去掉该 flag)
|
|
101
|
+
- [ ] config.rs: #[cfg(test)] config_dir/pi_dir → temp(或 TODO 已记录)
|
|
102
|
+
- [ ] workflow_dispatch 可手动触发
|
|
103
|
+
- [ ] npm view 回读 + 失败建 issue
|
|
104
|
+
```
|
|
@@ -1,71 +1,69 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: code-review
|
|
3
|
-
description: Review the changes since a fixed point (commit, branch, tag, or merge-base) along two axes
|
|
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
4
|
---
|
|
5
5
|
|
|
6
6
|
Two-axis review of the diff between `HEAD` and a fixed point the user supplies:
|
|
7
7
|
|
|
8
|
-
- **Standards
|
|
9
|
-
- **Spec
|
|
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
10
|
|
|
11
11
|
Both axes run as **parallel sub-agents** so they don't pollute each other's context, then this skill aggregates their findings.
|
|
12
12
|
|
|
13
|
-
The issue tracker should have been provided to you
|
|
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
14
|
|
|
15
15
|
## Process
|
|
16
16
|
|
|
17
17
|
### 1. Pin the fixed point
|
|
18
18
|
|
|
19
|
-
Whatever the user said is the fixed point
|
|
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
20
|
|
|
21
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
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
|
|
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
24
|
|
|
25
25
|
### 2. Identify the spec source
|
|
26
26
|
|
|
27
27
|
Look for the originating spec, in this order:
|
|
28
28
|
|
|
29
|
-
1. Issue references in the commit messages (`#123`, `Closes #45`, GitLab `!67`, etc.)
|
|
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
30
|
2. A path the user passed as an argument.
|
|
31
|
-
3. A
|
|
31
|
+
3. A spec file under `docs/`, `specs/`, or `.scratch/` matching the branch name or feature.
|
|
32
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
33
|
|
|
34
34
|
### 3. Identify the standards sources
|
|
35
35
|
|
|
36
36
|
Anything in the repo that documents how code should be written, such as `CODING_STANDARDS.md` or `CONTRIBUTING.md`.
|
|
37
37
|
|
|
38
|
-
On top of whatever the repo documents, the Standards axis always carries the **smell baseline** below
|
|
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
39
|
|
|
40
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
|
|
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
42
|
|
|
43
43
|
Each smell reads *what it is* → *how to fix*; match it against the diff:
|
|
44
44
|
|
|
45
|
-
- **Mysterious Name
|
|
46
|
-
- **Duplicated Code
|
|
47
|
-
- **Feature Envy
|
|
48
|
-
- **Data Clumps
|
|
49
|
-
- **Primitive Obsession
|
|
50
|
-
- **Repeated Switches
|
|
51
|
-
- **Shotgun Surgery
|
|
52
|
-
- **Divergent Change
|
|
53
|
-
- **Speculative Generality
|
|
54
|
-
- **Message Chains
|
|
55
|
-
- **Middle Man
|
|
56
|
-
- **Refused Bequest
|
|
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
57
|
|
|
58
58
|
### 4. Spawn both sub-agents in parallel
|
|
59
59
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
**Standards sub-agent prompt** — include:
|
|
60
|
+
**Standards sub-agent prompt** should include:
|
|
63
61
|
|
|
64
62
|
- The full diff command and commit list.
|
|
65
|
-
- The list of standards-source files you found in step 3, **plus the smell baseline from step 3** pasted in full
|
|
66
|
-
- The brief: "Report
|
|
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."
|
|
67
65
|
|
|
68
|
-
**Spec sub-agent prompt**
|
|
66
|
+
**Spec sub-agent prompt** should include:
|
|
69
67
|
|
|
70
68
|
- The diff command and commit list.
|
|
71
69
|
- The path or fetched contents of the spec.
|
|
@@ -75,14 +73,9 @@ If the spec is missing, skip the Spec sub-agent and note this in the final repor
|
|
|
75
73
|
|
|
76
74
|
### 5. Aggregate
|
|
77
75
|
|
|
78
|
-
Present the two reports under `## Standards` and `## Spec` headings, verbatim or lightly cleaned. Do **not** merge or rerank findings
|
|
79
|
-
|
|
80
|
-
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.
|
|
81
|
-
|
|
82
|
-
### 6. 输出形式
|
|
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_).
|
|
83
77
|
|
|
84
|
-
-
|
|
85
|
-
- 被 tdd-implement 阶段⑤编排时同样适用
|
|
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.
|
|
86
79
|
|
|
87
80
|
## Why two axes
|
|
88
81
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Deepening
|
|
2
2
|
|
|
3
|
-
How to deepen a cluster of shallow modules safely, given its dependencies. Assumes the vocabulary in [SKILL.md](SKILL.md)
|
|
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
4
|
|
|
5
5
|
## Dependency categories
|
|
6
6
|
|
|
@@ -8,7 +8,7 @@ When assessing a candidate for deepening, classify its dependencies. The categor
|
|
|
8
8
|
|
|
9
9
|
### 1. In-process
|
|
10
10
|
|
|
11
|
-
Pure computation, in-memory state, no I/O. Always deepenable
|
|
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
12
|
|
|
13
13
|
### 2. Local-substitutable
|
|
14
14
|
|
|
@@ -31,7 +31,7 @@ Third-party services (Stripe, Twilio, etc.) you don't control. The deepened modu
|
|
|
31
31
|
|
|
32
32
|
## Testing strategy: replace, don't layer
|
|
33
33
|
|
|
34
|
-
- Old unit tests on shallow modules become waste once tests at the deepened module's interface exist
|
|
34
|
+
- Old unit tests on shallow modules become waste once tests at the deepened module's interface exist; delete them.
|
|
35
35
|
- Write new tests at the deepened module's interface. The **interface is the test surface**.
|
|
36
36
|
- Tests assert on observable outcomes through the interface, not internal state.
|
|
37
|
-
- Tests should survive internal refactors
|
|
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,8 +1,8 @@
|
|
|
1
1
|
# Design It Twice
|
|
2
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)
|
|
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
4
|
|
|
5
|
-
Uses the vocabulary in [SKILL.md](SKILL.md)
|
|
5
|
+
Uses the vocabulary in [SKILL.md](SKILL.md): **module**, **interface**, **seam**, **adapter**, **leverage**.
|
|
6
6
|
|
|
7
7
|
## Process
|
|
8
8
|
|
|
@@ -12,33 +12,33 @@ Before spawning sub-agents, write a user-facing explanation of the problem space
|
|
|
12
12
|
|
|
13
13
|
- The constraints any new interface would need to satisfy
|
|
14
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
|
|
15
|
+
- A rough illustrative code sketch to ground the constraints, not a proposal, just a way to make the constraints concrete
|
|
16
16
|
|
|
17
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
18
|
|
|
19
19
|
### 2. Spawn sub-agents
|
|
20
20
|
|
|
21
|
-
Spawn 3+ sub-agents in parallel
|
|
21
|
+
Spawn 3+ sub-agents in parallel. Each must produce a **radically different** interface for the deepened module.
|
|
22
22
|
|
|
23
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
24
|
|
|
25
|
-
- Agent 1: "Minimize the interface
|
|
26
|
-
- Agent 2: "Maximise flexibility
|
|
27
|
-
- Agent 3: "Optimise for the most common caller
|
|
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
28
|
- Agent 4 (if applicable): "Design around ports & adapters for cross-seam dependencies."
|
|
29
29
|
|
|
30
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
31
|
|
|
32
32
|
Each sub-agent outputs:
|
|
33
33
|
|
|
34
|
-
1. Interface (types, methods, params
|
|
34
|
+
1. Interface (types, methods, params, plus invariants, ordering, error modes)
|
|
35
35
|
2. Usage example showing how callers use it
|
|
36
36
|
3. What the implementation hides behind the seam
|
|
37
37
|
4. Dependency strategy and adapters (see [DEEPENING.md](DEEPENING.md))
|
|
38
|
-
5. Trade-offs
|
|
38
|
+
5. Trade-offs: where leverage is high, where it's thin
|
|
39
39
|
|
|
40
40
|
### 3. Present and compare
|
|
41
41
|
|
|
42
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
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
|
|
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.
|
|
@@ -9,23 +9,23 @@ Design **deep modules**: a lot of behaviour behind a small interface, placed at
|
|
|
9
9
|
|
|
10
10
|
## Glossary
|
|
11
11
|
|
|
12
|
-
Use these terms exactly
|
|
12
|
+
Use these terms exactly: don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point.
|
|
13
13
|
|
|
14
|
-
**Module
|
|
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
15
|
|
|
16
|
-
**Interface
|
|
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
17
|
|
|
18
|
-
**Implementation
|
|
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
19
|
|
|
20
|
-
**Depth
|
|
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
21
|
|
|
22
|
-
**Seam** _(Michael Feathers)_
|
|
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
23
|
|
|
24
|
-
**Adapter
|
|
24
|
+
**Adapter**: a concrete thing that satisfies an interface at a seam. Describes *role* (what slot it fills), not substance (what's inside).
|
|
25
25
|
|
|
26
|
-
**Leverage
|
|
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
27
|
|
|
28
|
-
**Locality
|
|
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
29
|
|
|
30
30
|
## Deep vs shallow
|
|
31
31
|
|
|
@@ -59,7 +59,7 @@ When designing an interface, ask:
|
|
|
59
59
|
|
|
60
60
|
## Principles
|
|
61
61
|
|
|
62
|
-
- **Depth is a property of the interface, not the implementation.** A deep module can be internally composed of small, mockable, swappable parts
|
|
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
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
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
65
|
- **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a seam unless something actually varies across it.
|
|
@@ -105,10 +105,10 @@ Good interfaces make testing natural:
|
|
|
105
105
|
## Rejected framings
|
|
106
106
|
|
|
107
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
|
|
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
109
|
- **"Boundary"**: overloaded with DDD's bounded context. Say **seam** or **interface**.
|
|
110
110
|
|
|
111
111
|
## Going deeper
|
|
112
112
|
|
|
113
|
-
- **Deepening a cluster given its dependencies
|
|
114
|
-
- **Exploring alternative interfaces
|
|
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.
|