pi-dev 0.1.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/LICENSE +28 -0
- package/README.md +117 -0
- package/dist/cli.js +73 -0
- package/dist/install.js +101 -0
- package/dist/manifest.js +28 -0
- package/dist/paths.js +14 -0
- package/package.json +48 -0
- package/presets/preferences.md +74 -0
- package/skills/diagnose/SKILL.md +117 -0
- package/skills/diagnose/scripts/hitl-loop.template.sh +41 -0
- package/skills/do/SKILL.md +180 -0
- package/skills/grill-with-docs/ADR-FORMAT.md +47 -0
- package/skills/grill-with-docs/CONTEXT-FORMAT.md +77 -0
- package/skills/grill-with-docs/SKILL.md +88 -0
- package/skills/improve-codebase-architecture/DEEPENING.md +37 -0
- package/skills/improve-codebase-architecture/INTERFACE-DESIGN.md +44 -0
- package/skills/improve-codebase-architecture/LANGUAGE.md +53 -0
- package/skills/improve-codebase-architecture/SKILL.md +71 -0
- package/skills/migrate/SKILL.md +231 -0
- package/skills/recon-with-vision/SKILL.md +106 -0
- package/skills/setup/SKILL.md +121 -0
- package/skills/setup/domain.md +51 -0
- package/skills/setup/issue-tracker-github.md +22 -0
- package/skills/setup/issue-tracker-gitlab.md +23 -0
- package/skills/setup/issue-tracker-local.md +19 -0
- package/skills/setup/triage-labels.md +15 -0
- package/skills/taste/SKILL.md +148 -0
- package/skills/tdd/SKILL.md +109 -0
- package/skills/tdd/deep-modules.md +33 -0
- package/skills/tdd/interface-design.md +31 -0
- package/skills/tdd/mocking.md +59 -0
- package/skills/tdd/refactoring.md +10 -0
- package/skills/tdd/tests.md +61 -0
- package/skills/to-issues/SKILL.md +81 -0
- package/skills/to-prd/SKILL.md +74 -0
- package/skills/triage/AGENT-BRIEF.md +168 -0
- package/skills/triage/OUT-OF-SCOPE.md +101 -0
- package/skills/triage/SKILL.md +111 -0
- package/skills/where/SKILL.md +108 -0
- package/skills/zoom-out/SKILL.md +7 -0
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: do
|
|
3
|
+
description: One-shot engineering entry point. Classifies the user's request (intent + scope), loads merged preferences, runs the right chain of skills, and finishes the work. Refuses to start on un-migrated repos. Keep-going posture — expand scope and surface, never halt for ceremony. Call this for any non-trivial engineering request in any language ("버그 잡아줘", "기능 추가하자", "이 추출기 짜자", "이어서", etc).
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# /do — Engineering Flow
|
|
7
|
+
|
|
8
|
+
Single entry point for engineering work. Classifies the request, loads merged preferences, then runs the right chain of skills (`zoom-out`, `grill-with-docs`, `to-prd`, `to-issues`, `triage`, `tdd`, `improve-codebase-architecture`, `diagnose`, `recon-with-vision`) to completion.
|
|
9
|
+
|
|
10
|
+
The point: **one request → one finished outcome**, with as few user interruptions as the user's preferences allow.
|
|
11
|
+
|
|
12
|
+
## Hard rules
|
|
13
|
+
|
|
14
|
+
1. **Migration gate (strict).** If `docs/agents/preferences.md` does not contain the `<!-- migrated: ... -->` marker, **stop** and invoke `/migrate`. Do not run any engineering work on un-migrated repos. The user makes the migration decision; the skill executes it. No partial-migration shortcuts.
|
|
15
|
+
2. **Read preferences (3 layers).** Merge global (`~/.pi/agent/preferences.md`) → project (`docs/agents/preferences.md`) → package (`packages/<pkg>/preferences.md` if a single package is targeted). If global is missing, warn once and use built-in defaults from `/taste`.
|
|
16
|
+
3. **Treat preferences as decisions.** Any choice the merged prefs answer is **decided**. Do not re-ask.
|
|
17
|
+
4. **Keep going.** When something would normally cause a halt (ambiguous classification, scope creep beyond `change-budget`, missing follow-up), **expand and surface in the final summary** instead of stopping mid-flow. Halt only when:
|
|
18
|
+
- migration gate fails, OR
|
|
19
|
+
- GitHub gate fails (when GitHub is the tracker), OR
|
|
20
|
+
- a phase's terminal predicate fails twice and the failure cannot be characterised, OR
|
|
21
|
+
- user interrupts.
|
|
22
|
+
5. **No handoff files.** State of work lives in three places only: **code (git), issue tracker, merged preferences**. Do not create `.scratch/flow/`, `docs/handoff/`, or any session-log file. Phase outputs are remembered in-context; persistent decisions are committed to code or filed as issues.
|
|
23
|
+
6. **Side-effect gates respect prefs literally.** `auto-create-issues`, `auto-apply-labels`, `auto-commit-per-slice`, `auto-pr` follow merged prefs without reinterpretation.
|
|
24
|
+
7. **Status line per phase.** `[flow N/M] <phase-name> — <one-sentence what>`.
|
|
25
|
+
|
|
26
|
+
## Process
|
|
27
|
+
|
|
28
|
+
### Step 0 — Bootstrap
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
- Source ~/.pi/agent/load-env.sh if it exists, to load NPM_TOKEN and other
|
|
32
|
+
shared secrets from ~/.pi/agent/.env. Skills that need these (e.g. local
|
|
33
|
+
npm publish) can rely on them being in the environment.
|
|
34
|
+
- Check docs/agents/preferences.md for migration marker.
|
|
35
|
+
- Missing or no marker → invoke `/migrate`. Do not proceed until migrated.
|
|
36
|
+
- Read ~/.pi/agent/preferences.md (global). Missing → built-in defaults + one-line warning.
|
|
37
|
+
- Read docs/agents/preferences.md (project).
|
|
38
|
+
- Read packages/<pkg>/preferences.md if a single package is targeted.
|
|
39
|
+
- Merge global → project → package; last write wins per key.
|
|
40
|
+
- Read docs/agents/{issue-tracker,triage-labels,domain}.md.
|
|
41
|
+
- If GitHub is the tracker, run a 2-second readiness check (gh auth status, repo accessible). On fail, halt with fix commands.
|
|
42
|
+
- If any preferences file's last-updated > 90 days, append a one-line refresh hint to the final summary.
|
|
43
|
+
- If the user's request hints at continuation ("이어서", "지난번", "where were we", "다시 시작"), invoke `/where` (optional). Otherwise skip it — the migration-enforced state-of-work channels (code / issues / prefs) are usually enough.
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Step 1 — Classify intent
|
|
47
|
+
|
|
48
|
+
Pick exactly one **intent**:
|
|
49
|
+
|
|
50
|
+
- `feature` — new capability or extension
|
|
51
|
+
- `bug` — defect / wrong behaviour
|
|
52
|
+
- `perf` — regression or optimisation
|
|
53
|
+
- `refactor` — structural change, no behaviour delta
|
|
54
|
+
- `recon` — design/extractor/scraper exploration
|
|
55
|
+
- `docs` — documentation / context only
|
|
56
|
+
- `triage` — process an incoming ticket
|
|
57
|
+
|
|
58
|
+
If confidence < `interrupt-on-ambiguity` threshold, ask once with your top guess + alternatives. Otherwise commit and continue.
|
|
59
|
+
|
|
60
|
+
### Step 2 — Measure scope
|
|
61
|
+
|
|
62
|
+
Pick exactly one **scope**:
|
|
63
|
+
|
|
64
|
+
| scope | proxy |
|
|
65
|
+
| -------- | ---------------------------------------------------- |
|
|
66
|
+
| `nano` | one file, < ~30 LOC |
|
|
67
|
+
| `small` | one module/package, no public-API change |
|
|
68
|
+
| `medium` | one package + tests + ADR-worthy decision possible |
|
|
69
|
+
| `large` | cross-package, schema/API change, or multi-day plan |
|
|
70
|
+
|
|
71
|
+
If measured scope exceeds `change-budget` (e.g. `module` budget vs `cross-package` work), **expand the budget for this run**, log it for the final summary, and continue. Do not halt.
|
|
72
|
+
|
|
73
|
+
### Step 3 — Pick the chain
|
|
74
|
+
|
|
75
|
+
| intent × scope | chain |
|
|
76
|
+
| --------------------- | ------------------------------------------------------------------------------------ |
|
|
77
|
+
| feature × nano | `tdd` |
|
|
78
|
+
| feature × small | `(opt zoom-out) → tdd → (opt improve-codebase-architecture)` |
|
|
79
|
+
| feature × medium | `(opt zoom-out) → grill-lite → to-issues → tdd per slice → improve-codebase-architecture` |
|
|
80
|
+
| feature × large | `zoom-out → grill-with-docs → to-prd → to-issues → triage → tdd per slice → improve-codebase-architecture` |
|
|
81
|
+
| bug × nano/small | `diagnose → tdd (regression) → (opt improve-codebase-architecture)` |
|
|
82
|
+
| bug × medium/large | `diagnose → grill-lite → to-issues → tdd per slice → improve-codebase-architecture` |
|
|
83
|
+
| perf × any | same as bug, with diagnose Phase 1 emphasising a measurement loop |
|
|
84
|
+
| refactor × any | `(opt zoom-out) → improve-codebase-architecture → tdd (preserve behaviour)` |
|
|
85
|
+
| recon × any | `recon-with-vision → (opt to-prd / to-issues)` |
|
|
86
|
+
| docs × any | `grill-with-docs` |
|
|
87
|
+
| triage × any | `triage` |
|
|
88
|
+
|
|
89
|
+
`grill-lite` = run `grill-with-docs` only on questions prefs cannot answer. If prefs answer everything, skip entirely.
|
|
90
|
+
|
|
91
|
+
### Step 4 — Execute the chain
|
|
92
|
+
|
|
93
|
+
For each phase:
|
|
94
|
+
|
|
95
|
+
1. Print status line.
|
|
96
|
+
2. Run the phase. Use merged prefs to make every taste decision the phase exposes.
|
|
97
|
+
3. Check the terminal predicate. If fail, retry once with explicit diagnosis. If fail again, halt with reason.
|
|
98
|
+
4. Continue.
|
|
99
|
+
|
|
100
|
+
**No handoff writes.** Pass state in-context only.
|
|
101
|
+
|
|
102
|
+
### Step 5 — Live verification
|
|
103
|
+
|
|
104
|
+
Driven by **two separate prefs keys**:
|
|
105
|
+
|
|
106
|
+
- `local-live-policy` — local live verification (app actually runs locally; agent drives it). Default: `mandatory`.
|
|
107
|
+
- `ops-live-policy` — production / staging live verification (real users / real infra). Default: `risk-gated`.
|
|
108
|
+
|
|
109
|
+
Local live is **always required for any change that touches runtime behaviour**, unless the diff is purely documentation, type-only refactors, or test-only edits. Local live = the agent boots the app or the relevant subsystem, drives it, and confirms the change behaves as intended. The agent owns the orchestration; the user is not the test runner.
|
|
110
|
+
|
|
111
|
+
Ops live runs only when `ops-live-policy` triggers (risk-gated rules: external API, payment, auth, schema migration, business-critical rule, release).
|
|
112
|
+
|
|
113
|
+
If `local-live-policy=mandatory`, the agent uses the **Local-live playbook** in `docs/agents/preferences.md` (recorded by `/migrate`). If the playbook is in TODO state (heavy stack with no local boot ever set up), the agent:
|
|
114
|
+
|
|
115
|
+
1. Builds a minimal harness for the targeted subsystem (CLI invocation, single-service spawn, or in-process driver).
|
|
116
|
+
2. Probes the alive-probe signal recorded in the playbook.
|
|
117
|
+
3. Updates the playbook in place if a new boot path emerged.
|
|
118
|
+
|
|
119
|
+
The user is **not** asked to run anything during a normal flow. The user is consulted again only if (a) the playbook is broken at a structural level (infra changed, secrets rotated, ops connection refused) — surfaced via the failure protocol, or (b) `local-live-policy=mandatory` plus a heavy stack the agent genuinely cannot orchestrate (rare; surface honestly).
|
|
120
|
+
|
|
121
|
+
### Step 6 — Side effects
|
|
122
|
+
|
|
123
|
+
Apply per merged prefs:
|
|
124
|
+
|
|
125
|
+
- Issues / labels: per `auto-create-issues`, `auto-apply-labels`
|
|
126
|
+
- Commits: per `auto-commit-per-slice`
|
|
127
|
+
- Push / PR: per `auto-pr`
|
|
128
|
+
|
|
129
|
+
If a side-effect was skipped because prefs said so, list it in the final summary so the user can do it manually.
|
|
130
|
+
|
|
131
|
+
### Step 7 — Final summary
|
|
132
|
+
|
|
133
|
+
One screen:
|
|
134
|
+
|
|
135
|
+
- intent / scope / chain executed
|
|
136
|
+
- diffs (files touched)
|
|
137
|
+
- side effects done (issue URLs, commit SHAs, branch name, PR URL)
|
|
138
|
+
- side effects deferred (with reason and the exact command to do them)
|
|
139
|
+
- expansions (scope went beyond budget, ambiguous decisions made with rationale)
|
|
140
|
+
- prefs refresh hint if stale
|
|
141
|
+
|
|
142
|
+
## Phase contracts (terminal predicates)
|
|
143
|
+
|
|
144
|
+
| phase | done when… |
|
|
145
|
+
| ---------------------------------- | --------------------------------------------------------------------------------------- |
|
|
146
|
+
| `zoom-out` | module map produced with glossary-aligned names |
|
|
147
|
+
| `grill-with-docs` / `grill-lite` | every open question answered, deferred with rationale, or escalated; relevant CONTEXT/ADR updates committed |
|
|
148
|
+
| `to-prd` | PRD published to issue tracker with `needs-triage` (per `auto-create-issues`) |
|
|
149
|
+
| `to-issues` | all slices created on tracker; each is independently grabbable; labels applied per `auto-apply-labels` |
|
|
150
|
+
| `triage` | issue carries exactly one state label; AI disclaimer present |
|
|
151
|
+
| `diagnose` | reproducible pass/fail loop exists AND root cause identified AND regression test exists |
|
|
152
|
+
| `tdd` | new test red→green; project's check command clean; commit per `auto-commit-per-slice` |
|
|
153
|
+
| `improve-codebase-architecture` | proposed deepening either applied or recorded as a follow-up issue |
|
|
154
|
+
| `recon-with-vision` | fixture saved; verified field list documented; schema locked |
|
|
155
|
+
| local live verification | agent drove the subsystem; observed behaviour matches intent; evidence captured (log line, screenshot, or output snippet) embedded in the final summary |
|
|
156
|
+
|
|
157
|
+
## Ambiguity protocol
|
|
158
|
+
|
|
159
|
+
When you must interrupt (only after exhausting prefs):
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
[flow] Need one decision — preferences don't cover this.
|
|
163
|
+
|
|
164
|
+
Question: <one-line>
|
|
165
|
+
My default: <choice + 1-line rationale>
|
|
166
|
+
Alternatives: <a> | <b>
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
If the user answers, (offer to) add to `preferences.md`.
|
|
170
|
+
|
|
171
|
+
## Failure protocol
|
|
172
|
+
|
|
173
|
+
If a phase's terminal predicate cannot be met after two honest attempts, stop and surface a short "blocked at phase X — reason — options" message. Do not silently proceed.
|
|
174
|
+
|
|
175
|
+
## What this skill does not do
|
|
176
|
+
|
|
177
|
+
- It does not bypass the migration gate.
|
|
178
|
+
- It does not modify `preferences.md` itself; that is `/taste`'s job.
|
|
179
|
+
- It does not write handoff files.
|
|
180
|
+
- It does not delegate live verification to the user — it orchestrates it.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# ADR Format
|
|
2
|
+
|
|
3
|
+
ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
|
|
4
|
+
|
|
5
|
+
Create the `docs/adr/` directory lazily — only when the first ADR is needed.
|
|
6
|
+
|
|
7
|
+
## Template
|
|
8
|
+
|
|
9
|
+
```md
|
|
10
|
+
# {Short title of the decision}
|
|
11
|
+
|
|
12
|
+
{1-3 sentences: what's the context, what did we decide, and why.}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why* — not in filling out sections.
|
|
16
|
+
|
|
17
|
+
## Optional sections
|
|
18
|
+
|
|
19
|
+
Only include these when they add genuine value. Most ADRs won't need them.
|
|
20
|
+
|
|
21
|
+
- **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`) — useful when decisions are revisited
|
|
22
|
+
- **Considered Options** — only when the rejected alternatives are worth remembering
|
|
23
|
+
- **Consequences** — only when non-obvious downstream effects need to be called out
|
|
24
|
+
|
|
25
|
+
## Numbering
|
|
26
|
+
|
|
27
|
+
Scan `docs/adr/` for the highest existing number and increment by one.
|
|
28
|
+
|
|
29
|
+
## When to offer an ADR
|
|
30
|
+
|
|
31
|
+
All three of these must be true:
|
|
32
|
+
|
|
33
|
+
1. **Hard to reverse** — the cost of changing your mind later is meaningful
|
|
34
|
+
2. **Surprising without context** — a future reader will look at the code and wonder "why on earth did they do it this way?"
|
|
35
|
+
3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
|
|
36
|
+
|
|
37
|
+
If a decision is easy to reverse, skip it — you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."
|
|
38
|
+
|
|
39
|
+
### What qualifies
|
|
40
|
+
|
|
41
|
+
- **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
|
|
42
|
+
- **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
|
|
43
|
+
- **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library — just the ones that would take a quarter to swap out.
|
|
44
|
+
- **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
|
|
45
|
+
- **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
|
|
46
|
+
- **Constraints not visible in the code.** "We can't use AWS because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
|
|
47
|
+
- **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it — otherwise someone will suggest GraphQL again in six months.
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# CONTEXT.md Format
|
|
2
|
+
|
|
3
|
+
## Structure
|
|
4
|
+
|
|
5
|
+
```md
|
|
6
|
+
# {Context Name}
|
|
7
|
+
|
|
8
|
+
{One or two sentence description of what this context is and why it exists.}
|
|
9
|
+
|
|
10
|
+
## Language
|
|
11
|
+
|
|
12
|
+
**Order**:
|
|
13
|
+
{A concise description of the term}
|
|
14
|
+
_Avoid_: Purchase, transaction
|
|
15
|
+
|
|
16
|
+
**Invoice**:
|
|
17
|
+
A request for payment sent to a customer after delivery.
|
|
18
|
+
_Avoid_: Bill, payment request
|
|
19
|
+
|
|
20
|
+
**Customer**:
|
|
21
|
+
A person or organization that places orders.
|
|
22
|
+
_Avoid_: Client, buyer, account
|
|
23
|
+
|
|
24
|
+
## Relationships
|
|
25
|
+
|
|
26
|
+
- An **Order** produces one or more **Invoices**
|
|
27
|
+
- An **Invoice** belongs to exactly one **Customer**
|
|
28
|
+
|
|
29
|
+
## Example dialogue
|
|
30
|
+
|
|
31
|
+
> **Dev:** "When a **Customer** places an **Order**, do we create the **Invoice** immediately?"
|
|
32
|
+
> **Domain expert:** "No — an **Invoice** is only generated once a **Fulfillment** is confirmed."
|
|
33
|
+
|
|
34
|
+
## Flagged ambiguities
|
|
35
|
+
|
|
36
|
+
- "account" was used to mean both **Customer** and **User** — resolved: these are distinct concepts.
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Rules
|
|
40
|
+
|
|
41
|
+
- **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others as aliases to avoid.
|
|
42
|
+
- **Flag conflicts explicitly.** If a term is used ambiguously, call it out in "Flagged ambiguities" with a clear resolution.
|
|
43
|
+
- **Keep definitions tight.** One sentence max. Define what it IS, not what it does.
|
|
44
|
+
- **Show relationships.** Use bold term names and express cardinality where obvious.
|
|
45
|
+
- **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
|
|
46
|
+
- **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
|
|
47
|
+
- **Write an example dialogue.** A conversation between a dev and a domain expert that demonstrates how the terms interact naturally and clarifies boundaries between related concepts.
|
|
48
|
+
|
|
49
|
+
## Single vs multi-context repos
|
|
50
|
+
|
|
51
|
+
**Single context (most repos):** One `CONTEXT.md` at the repo root.
|
|
52
|
+
|
|
53
|
+
**Multiple contexts:** A `CONTEXT-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:
|
|
54
|
+
|
|
55
|
+
```md
|
|
56
|
+
# Context Map
|
|
57
|
+
|
|
58
|
+
## Contexts
|
|
59
|
+
|
|
60
|
+
- [Ordering](./src/ordering/CONTEXT.md) — receives and tracks customer orders
|
|
61
|
+
- [Billing](./src/billing/CONTEXT.md) — generates invoices and processes payments
|
|
62
|
+
- [Fulfillment](./src/fulfillment/CONTEXT.md) — manages warehouse picking and shipping
|
|
63
|
+
|
|
64
|
+
## Relationships
|
|
65
|
+
|
|
66
|
+
- **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
|
|
67
|
+
- **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
|
|
68
|
+
- **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
The skill infers which structure applies:
|
|
72
|
+
|
|
73
|
+
- If `CONTEXT-MAP.md` exists, read it to find contexts
|
|
74
|
+
- If only a root `CONTEXT.md` exists, single context
|
|
75
|
+
- If neither exists, create a root `CONTEXT.md` lazily when the first term is resolved
|
|
76
|
+
|
|
77
|
+
When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: grill-with-docs
|
|
3
|
+
description: Grilling session that challenges your plan against the existing domain model, sharpens terminology, and updates documentation (CONTEXT.md, ADRs) inline as decisions crystallise. Use when user wants to stress-test a plan against their project's language and documented decisions.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
<what-to-do>
|
|
7
|
+
|
|
8
|
+
Interview me relentlessly about every aspect of this plan until we reach a shared understanding. Walk down each branch of the design tree, resolving dependencies between decisions one-by-one. For each question, provide your recommended answer.
|
|
9
|
+
|
|
10
|
+
Ask the questions one at a time, waiting for feedback on each question before continuing.
|
|
11
|
+
|
|
12
|
+
If a question can be answered by exploring the codebase, explore the codebase instead.
|
|
13
|
+
|
|
14
|
+
</what-to-do>
|
|
15
|
+
|
|
16
|
+
<supporting-info>
|
|
17
|
+
|
|
18
|
+
## Domain awareness
|
|
19
|
+
|
|
20
|
+
During codebase exploration, read `docs/agents/domain.md` first if it exists, then look for existing documentation:
|
|
21
|
+
|
|
22
|
+
### File structure
|
|
23
|
+
|
|
24
|
+
Most repos have a single context:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
/
|
|
28
|
+
├── CONTEXT.md
|
|
29
|
+
├── docs/
|
|
30
|
+
│ └── adr/
|
|
31
|
+
│ ├── 0001-event-sourced-orders.md
|
|
32
|
+
│ └── 0002-postgres-for-write-model.md
|
|
33
|
+
└── src/
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
If a `CONTEXT-MAP.md` exists at the root, the repo has multiple contexts. The map points to where each one lives:
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
/
|
|
40
|
+
├── CONTEXT-MAP.md
|
|
41
|
+
├── docs/
|
|
42
|
+
│ └── adr/ ← system-wide decisions
|
|
43
|
+
├── src/
|
|
44
|
+
│ ├── ordering/
|
|
45
|
+
│ │ ├── CONTEXT.md
|
|
46
|
+
│ │ └── docs/adr/ ← context-specific decisions
|
|
47
|
+
│ └── billing/
|
|
48
|
+
│ ├── CONTEXT.md
|
|
49
|
+
│ └── docs/adr/
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Create files lazily — only when you have something to write. If no `CONTEXT.md` exists, create one when the first term is resolved. If no `docs/adr/` exists, create it when the first ADR is needed.
|
|
53
|
+
|
|
54
|
+
## During the session
|
|
55
|
+
|
|
56
|
+
### Challenge against the glossary
|
|
57
|
+
|
|
58
|
+
When the user uses a term that conflicts with the existing language in `CONTEXT.md`, call it out immediately. "Your glossary defines 'cancellation' as X, but you seem to mean Y — which is it?"
|
|
59
|
+
|
|
60
|
+
### Sharpen fuzzy language
|
|
61
|
+
|
|
62
|
+
When the user uses vague or overloaded terms, propose a precise canonical term. "You're saying 'account' — do you mean the Customer or the User? Those are different things."
|
|
63
|
+
|
|
64
|
+
### Discuss concrete scenarios
|
|
65
|
+
|
|
66
|
+
When domain relationships are being discussed, stress-test them with specific scenarios. Invent scenarios that probe edge cases and force the user to be precise about the boundaries between concepts.
|
|
67
|
+
|
|
68
|
+
### Cross-reference with code
|
|
69
|
+
|
|
70
|
+
When the user states how something works, check whether the code agrees. If you find a contradiction, surface it: "Your code cancels entire Orders, but you just said partial cancellation is possible — which is right?"
|
|
71
|
+
|
|
72
|
+
### Update CONTEXT.md inline
|
|
73
|
+
|
|
74
|
+
When a term is resolved, update `CONTEXT.md` right there. Don't batch these up — capture them as they happen. Use the format in [CONTEXT-FORMAT.md](./CONTEXT-FORMAT.md).
|
|
75
|
+
|
|
76
|
+
Don't couple `CONTEXT.md` to implementation details. Only include terms that are meaningful to domain experts.
|
|
77
|
+
|
|
78
|
+
### Offer ADRs sparingly
|
|
79
|
+
|
|
80
|
+
Only offer to create an ADR when all three are true:
|
|
81
|
+
|
|
82
|
+
1. **Hard to reverse** — the cost of changing your mind later is meaningful
|
|
83
|
+
2. **Surprising without context** — a future reader will wonder "why did they do it this way?"
|
|
84
|
+
3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
|
|
85
|
+
|
|
86
|
+
If any of the three is missing, skip the ADR. Use the format in [ADR-FORMAT.md](./ADR-FORMAT.md).
|
|
87
|
+
|
|
88
|
+
</supporting-info>
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Deepening
|
|
2
|
+
|
|
3
|
+
How to deepen a cluster of shallow modules safely, given its dependencies. Assumes the vocabulary in [LANGUAGE.md](LANGUAGE.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 — they describe behaviour, not implementation. If a test has to change when the implementation changes, it's testing past the interface.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Interface Design
|
|
2
|
+
|
|
3
|
+
When the user wants to explore alternative interfaces for a chosen deepening candidate, use this multi-pass design pattern. Based on "Design It Twice" (Ousterhout) — your first idea is unlikely to be the best.
|
|
4
|
+
|
|
5
|
+
Uses the vocabulary in [LANGUAGE.md](LANGUAGE.md) — **module**, **interface**, **seam**, **adapter**, **leverage**.
|
|
6
|
+
|
|
7
|
+
## Process
|
|
8
|
+
|
|
9
|
+
### 1. Frame the problem space
|
|
10
|
+
|
|
11
|
+
Before generating alternatives, 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 alternatives are generated.
|
|
18
|
+
|
|
19
|
+
### 2. Generate alternatives
|
|
20
|
+
|
|
21
|
+
Generate 3+ **radically different** interfaces for the deepened module. If the runtime offers subagents, run them in parallel. Otherwise, run separate design passes yourself and keep their constraints independent.
|
|
22
|
+
|
|
23
|
+
Use a separate technical brief for each pass (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 pass a different design constraint:
|
|
24
|
+
|
|
25
|
+
- Pass 1: "Minimize the interface — aim for 1–3 entry points max. Maximise leverage per entry point."
|
|
26
|
+
- Pass 2: "Maximise flexibility — support many use cases and extension."
|
|
27
|
+
- Pass 3: "Optimise for the most common caller — make the default case trivial."
|
|
28
|
+
- Pass 4 (if applicable): "Design around ports & adapters for cross-seam dependencies."
|
|
29
|
+
|
|
30
|
+
Include both [LANGUAGE.md](LANGUAGE.md) vocabulary and CONTEXT.md vocabulary in the brief so each pass names things consistently with the architecture language and the project's domain language.
|
|
31
|
+
|
|
32
|
+
Each pass 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.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Language
|
|
2
|
+
|
|
3
|
+
Shared vocabulary for every suggestion this skill makes. Use these terms exactly — don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point.
|
|
4
|
+
|
|
5
|
+
## Terms
|
|
6
|
+
|
|
7
|
+
**Module**
|
|
8
|
+
Anything with an interface and an implementation. Deliberately scale-agnostic — applies equally to a function, class, package, or tier-spanning slice.
|
|
9
|
+
_Avoid_: unit, component, service.
|
|
10
|
+
|
|
11
|
+
**Interface**
|
|
12
|
+
Everything a caller must know to use the module correctly. Includes the type signature, but also invariants, ordering constraints, error modes, required configuration, and performance characteristics.
|
|
13
|
+
_Avoid_: API, signature (too narrow — those refer only to the type-level surface).
|
|
14
|
+
|
|
15
|
+
**Implementation**
|
|
16
|
+
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.
|
|
17
|
+
|
|
18
|
+
**Depth**
|
|
19
|
+
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. A module is **shallow** when the interface is nearly as complex as the implementation.
|
|
20
|
+
|
|
21
|
+
**Seam** _(from Michael Feathers)_
|
|
22
|
+
A place where you can alter behaviour without editing in that place. The *location* at which a module's interface lives. Choosing where to put the seam is its own design decision, distinct from what goes behind it.
|
|
23
|
+
_Avoid_: boundary (overloaded with DDD's bounded context).
|
|
24
|
+
|
|
25
|
+
**Adapter**
|
|
26
|
+
A concrete thing that satisfies an interface at a seam. Describes *role* (what slot it fills), not substance (what's inside).
|
|
27
|
+
|
|
28
|
+
**Leverage**
|
|
29
|
+
What callers get from depth. More capability per unit of interface they have to learn. One implementation pays back across N call sites and M tests.
|
|
30
|
+
|
|
31
|
+
**Locality**
|
|
32
|
+
What maintainers get from depth. Change, bugs, knowledge, and verification concentrate at one place rather than spreading across callers. Fix once, fixed everywhere.
|
|
33
|
+
|
|
34
|
+
## Principles
|
|
35
|
+
|
|
36
|
+
- **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.
|
|
37
|
+
- **The deletion test.** Imagine deleting the module. If complexity vanishes, the module wasn't hiding anything (it was a pass-through). If complexity reappears across N callers, the module was earning its keep.
|
|
38
|
+
- **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.
|
|
39
|
+
- **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a seam unless something actually varies across it.
|
|
40
|
+
|
|
41
|
+
## Relationships
|
|
42
|
+
|
|
43
|
+
- A **Module** has exactly one **Interface** (the surface it presents to callers and tests).
|
|
44
|
+
- **Depth** is a property of a **Module**, measured against its **Interface**.
|
|
45
|
+
- A **Seam** is where a **Module**'s **Interface** lives.
|
|
46
|
+
- An **Adapter** sits at a **Seam** and satisfies the **Interface**.
|
|
47
|
+
- **Depth** produces **Leverage** for callers and **Locality** for maintainers.
|
|
48
|
+
|
|
49
|
+
## Rejected framings
|
|
50
|
+
|
|
51
|
+
- **Depth as ratio of implementation-lines to interface-lines** (Ousterhout): rewards padding the implementation. We use depth-as-leverage instead.
|
|
52
|
+
- **"Interface" as the TypeScript `interface` keyword or a class's public methods**: too narrow — interface here includes every fact a caller must know.
|
|
53
|
+
- **"Boundary"**: overloaded with DDD's bounded context. Say **seam** or **interface**.
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: improve-codebase-architecture
|
|
3
|
+
description: Find deepening opportunities in a codebase, informed by the domain language in CONTEXT.md and the decisions in docs/adr/. Use when the user wants to improve architecture, find refactoring opportunities, consolidate tightly-coupled modules, or make a codebase more testable and AI-navigable.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Improve Codebase Architecture
|
|
7
|
+
|
|
8
|
+
Surface architectural friction and propose **deepening opportunities** — refactors that turn shallow modules into deep ones. The aim is testability and AI-navigability.
|
|
9
|
+
|
|
10
|
+
## Glossary
|
|
11
|
+
|
|
12
|
+
Use these terms exactly in every suggestion. Consistent language is the point — don't drift into "component," "service," "API," or "boundary." Full definitions in [LANGUAGE.md](LANGUAGE.md).
|
|
13
|
+
|
|
14
|
+
- **Module** — anything with an interface and an implementation (function, class, package, slice).
|
|
15
|
+
- **Interface** — everything a caller must know to use the module: types, invariants, error modes, ordering, config. Not just the type signature.
|
|
16
|
+
- **Implementation** — the code inside.
|
|
17
|
+
- **Depth** — leverage at the interface: a lot of behaviour behind a small interface. **Deep** = high leverage. **Shallow** = interface nearly as complex as the implementation.
|
|
18
|
+
- **Seam** — where an interface lives; a place behaviour can be altered without editing in place. (Use this, not "boundary.")
|
|
19
|
+
- **Adapter** — a concrete thing satisfying an interface at a seam.
|
|
20
|
+
- **Leverage** — what callers get from depth.
|
|
21
|
+
- **Locality** — what maintainers get from depth: change, bugs, knowledge concentrated in one place.
|
|
22
|
+
|
|
23
|
+
Key principles (see [LANGUAGE.md](LANGUAGE.md) for the full list):
|
|
24
|
+
|
|
25
|
+
- **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.
|
|
26
|
+
- **The interface is the test surface.**
|
|
27
|
+
- **One adapter = hypothetical seam. Two adapters = real seam.**
|
|
28
|
+
|
|
29
|
+
This skill is _informed_ by the project's domain model. The domain language gives names to good seams; ADRs record decisions the skill should not re-litigate.
|
|
30
|
+
|
|
31
|
+
## Process
|
|
32
|
+
|
|
33
|
+
### 1. Explore
|
|
34
|
+
|
|
35
|
+
Read `docs/agents/domain.md` if it exists, then read the project's domain glossary, relevant project docs, and any ADRs in the area you're touching.
|
|
36
|
+
|
|
37
|
+
Then walk the codebase. If the runtime offers subagents, use an Explore subagent; otherwise run an explicit exploration pass yourself. Don't follow rigid heuristics — explore organically and note where you experience friction:
|
|
38
|
+
|
|
39
|
+
- Where does understanding one concept require bouncing between many small modules?
|
|
40
|
+
- Where are modules **shallow** — interface nearly as complex as the implementation?
|
|
41
|
+
- Where have pure functions been extracted just for testability, but the real bugs hide in how they're called (no **locality**)?
|
|
42
|
+
- Where do tightly-coupled modules leak across their seams?
|
|
43
|
+
- Which parts of the codebase are untested, or hard to test through their current interface?
|
|
44
|
+
|
|
45
|
+
Apply the **deletion test** to anything you suspect is shallow: would deleting it concentrate complexity, or just move it? A "yes, concentrates" is the signal you want.
|
|
46
|
+
|
|
47
|
+
### 2. Present candidates
|
|
48
|
+
|
|
49
|
+
Present a numbered list of deepening opportunities. For each candidate:
|
|
50
|
+
|
|
51
|
+
- **Files** — which files/modules are involved
|
|
52
|
+
- **Problem** — why the current architecture is causing friction
|
|
53
|
+
- **Solution** — plain English description of what would change
|
|
54
|
+
- **Benefits** — explained in terms of locality and leverage, and also in how tests would improve
|
|
55
|
+
|
|
56
|
+
**Use CONTEXT.md vocabulary for the domain, and [LANGUAGE.md](LANGUAGE.md) vocabulary for the architecture.** If `CONTEXT.md` defines "Order," talk about "the Order intake module" — not "the FooBarHandler," and not "the Order service."
|
|
57
|
+
|
|
58
|
+
**ADR conflicts**: if a candidate contradicts an existing ADR, only surface it when the friction is real enough to warrant revisiting the ADR. Mark it clearly (e.g. _"contradicts ADR-0007 — but worth reopening because…"_). Don't list every theoretical refactor an ADR forbids.
|
|
59
|
+
|
|
60
|
+
Do NOT propose interfaces yet. Ask the user: "Which of these would you like to explore?"
|
|
61
|
+
|
|
62
|
+
### 3. Grilling loop
|
|
63
|
+
|
|
64
|
+
Once the user picks a candidate, drop into a grilling conversation. Walk the design tree with them — constraints, dependencies, the shape of the deepened module, what sits behind the seam, what tests survive.
|
|
65
|
+
|
|
66
|
+
Side effects happen inline as decisions crystallize:
|
|
67
|
+
|
|
68
|
+
- **Naming a deepened module after a concept not in `CONTEXT.md`?** Add the term to `CONTEXT.md` — same discipline as `/grill-with-docs` (see [CONTEXT-FORMAT.md](../grill-with-docs/CONTEXT-FORMAT.md)). Create the file lazily if it doesn't exist.
|
|
69
|
+
- **Sharpening a fuzzy term during the conversation?** Update `CONTEXT.md` right there.
|
|
70
|
+
- **User rejects the candidate with a load-bearing reason?** Offer an ADR, framed as: _"Want me to record this as an ADR so future architecture reviews don't re-suggest it?"_ Only offer when the reason would actually be needed by a future explorer to avoid re-suggesting the same thing — skip ephemeral reasons ("not worth it right now") and self-evident ones. See [ADR-FORMAT.md](../grill-with-docs/ADR-FORMAT.md).
|
|
71
|
+
- **Want to explore alternative interfaces for the deepened module?** See [INTERFACE-DESIGN.md](INTERFACE-DESIGN.md).
|