Skip to content

Commit 055f883

Browse files
Merge pull request #18 from pie-framework/CONTOOL-2194_add_parity_route
Parity of rendering for McPopulatedBlank
2 parents cbe4668 + e72ef8e commit 055f883

204 files changed

Lines changed: 10740 additions & 1481 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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, also 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>
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Interface Design
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 [LANGUAGE.md](LANGUAGE.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 using the Agent tool. 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 [LANGUAGE.md](LANGUAGE.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.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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 commit comments

Comments
 (0)