@zedtech/zedkit-ai 0.0.0-stage → 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +175 -2
- package/kit/AGENTS.template.md +96 -0
- package/kit/THIRD_PARTY_NOTICES.md +63 -0
- package/kit/agents/architect.md +48 -0
- package/kit/agents/explorer.md +33 -0
- package/kit/agents/improver.md +34 -0
- package/kit/agents/plan-challenger.md +50 -0
- package/kit/agents/security-reviewer.md +33 -0
- package/kit/agents/verifier.md +39 -0
- package/kit/commands/challenge.md +5 -0
- package/kit/commands/handoff.md +5 -0
- package/kit/commands/implement.md +5 -0
- package/kit/commands/plan.md +5 -0
- package/kit/commands/pr.md +5 -0
- package/kit/commands/review.md +5 -0
- package/kit/commands/setup-ai.md +5 -0
- package/kit/kit.json +47 -0
- package/kit/skills/LICENSE-humanlayer-Apache-2.0 +202 -0
- package/kit/skills/LICENSE-mattpocock-skills-MIT +21 -0
- package/kit/skills/LICENSE-ponytail-MIT +21 -0
- package/kit/skills/adversarial-tests/SKILL.md +64 -0
- package/kit/skills/challenge/SKILL.md +18 -0
- package/kit/skills/code-review/SKILL.md +74 -0
- package/kit/skills/code-review/agents/openai.yaml +3 -0
- package/kit/skills/codebase-design/DEEPENING.md +37 -0
- package/kit/skills/codebase-design/DESIGN-IT-TWICE.md +44 -0
- package/kit/skills/codebase-design/SKILL.md +114 -0
- package/kit/skills/codebase-design/agents/openai.yaml +3 -0
- package/kit/skills/definition-of-done/SKILL.md +53 -0
- package/kit/skills/diagnosing-bugs/SKILL.md +138 -0
- package/kit/skills/diagnosing-bugs/agents/openai.yaml +3 -0
- package/kit/skills/diagnosing-bugs/scripts/hitl-loop.template.sh +44 -0
- package/kit/skills/domain-modeling/ADR-FORMAT.md +47 -0
- package/kit/skills/domain-modeling/GLOSSARY-FORMAT.md +60 -0
- package/kit/skills/domain-modeling/SKILL.md +74 -0
- package/kit/skills/domain-modeling/agents/openai.yaml +3 -0
- package/kit/skills/ground-truth/SKILL.md +50 -0
- package/kit/skills/handoff/SKILL.md +16 -0
- package/kit/skills/handoff/agents/openai.yaml +5 -0
- package/kit/skills/implement/SKILL.md +25 -0
- package/kit/skills/implement/agents/openai.yaml +5 -0
- package/kit/skills/implement-spec/SKILL.md +42 -0
- package/kit/skills/implement-spec/agents/openai.yaml +5 -0
- package/kit/skills/improve-codebase-architecture/HTML-REPORT.md +123 -0
- package/kit/skills/improve-codebase-architecture/SKILL.md +71 -0
- package/kit/skills/improve-codebase-architecture/agents/openai.yaml +5 -0
- package/kit/skills/parallel-work/SKILL.md +61 -0
- package/kit/skills/persona-review/SKILL.md +38 -0
- package/kit/skills/plan/SKILL.md +38 -0
- package/kit/skills/ponytail/SKILL.md +53 -0
- package/kit/skills/ponytail-audit/SKILL.md +103 -0
- package/kit/skills/ponytail-debt/SKILL.md +44 -0
- package/kit/skills/ponytail-gain/SKILL.md +52 -0
- package/kit/skills/ponytail-help/SKILL.md +76 -0
- package/kit/skills/ponytail-review/SKILL.md +119 -0
- package/kit/skills/pr/CREDITS.md +3 -0
- package/kit/skills/pr/SKILL.md +170 -0
- package/kit/skills/pr/agents/openai.yaml +3 -0
- package/kit/skills/research/SKILL.md +12 -0
- package/kit/skills/research/agents/openai.yaml +3 -0
- package/kit/skills/retro/SKILL.md +44 -0
- package/kit/skills/retro/agents/openai.yaml +5 -0
- package/kit/skills/review/SKILL.md +37 -0
- package/kit/skills/rules-upkeep/SKILL.md +55 -0
- package/kit/skills/setup-ai/SKILL.md +139 -0
- package/kit/skills/setup-matt-pocock-skills/SKILL.md +118 -0
- package/kit/skills/setup-matt-pocock-skills/agents/openai.yaml +5 -0
- package/kit/skills/setup-matt-pocock-skills/domain.md +51 -0
- package/kit/skills/setup-matt-pocock-skills/issue-tracker-github.md +46 -0
- package/kit/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +46 -0
- package/kit/skills/setup-matt-pocock-skills/issue-tracker-local.md +30 -0
- package/kit/skills/setup-matt-pocock-skills/triage-labels.md +15 -0
- package/kit/skills/setup-ts-deep-modules/SKILL.md +102 -0
- package/kit/skills/setup-ts-deep-modules/agents/openai.yaml +5 -0
- package/kit/skills/setup-ts-deep-modules/dependency-cruiser.config.cjs +95 -0
- package/kit/skills/tdd/SKILL.md +38 -0
- package/kit/skills/tdd/agents/openai.yaml +3 -0
- package/kit/skills/tdd/mocking.md +59 -0
- package/kit/skills/tdd/tests.md +77 -0
- package/kit/skills/to-spec/SKILL.md +75 -0
- package/kit/skills/to-spec/agents/openai.yaml +5 -0
- package/kit/skills/to-tickets/SKILL.md +105 -0
- package/kit/skills/to-tickets/agents/openai.yaml +5 -0
- package/kit/skills/triage/AGENT-BRIEF.md +207 -0
- package/kit/skills/triage/OUT-OF-SCOPE.md +105 -0
- package/kit/skills/triage/SKILL.md +112 -0
- package/kit/skills/triage/agents/openai.yaml +5 -0
- package/kit/skills/use-zedkit/SKILL.md +32 -0
- package/kit/skills/wayfinder/SKILL.md +128 -0
- package/kit/skills/wayfinder/agents/openai.yaml +5 -0
- package/kit/skills/writing-for-agents/SKILL-MECHANICS.md +22 -0
- package/kit/skills/writing-for-agents/SKILL.md +81 -0
- package/kit/skills/writing-for-agents/agents/openai.yaml +3 -0
- package/package.json +48 -3
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: definition-of-done
|
|
3
|
+
description: "Checklist to pass before calling a code change done: real gates on the final state, tests for every changed file, no weakened tests, refactor parity, a cold second review. Use at the end of any code change and before opening a PR."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Definition of done
|
|
7
|
+
|
|
8
|
+
Done is a claim. This list is the evidence. If one box cannot be ticked, say which and why. Never tick from memory.
|
|
9
|
+
|
|
10
|
+
## Gates
|
|
11
|
+
|
|
12
|
+
- [ ] The project's own gates ran **after the last edit**: typecheck, lint, tests, build (read the commands in the manifest). A fix made after the run means run again.
|
|
13
|
+
- [ ] Output was read, not assumed. A failure you cannot explain is not done.
|
|
14
|
+
- [ ] Nothing generated, built or cached is staged: check `git status` and `git diff --stat HEAD`. Never `git add -A` blindly.
|
|
15
|
+
- [ ] No secrets, tokens or personal data in code, tests, logs, fixtures or errors.
|
|
16
|
+
|
|
17
|
+
## Tests
|
|
18
|
+
|
|
19
|
+
- [ ] Every changed behavior has a test. Bug fix: a regression test that fails without the fix. Use `tdd`; for edge cases use `adversarial-tests`.
|
|
20
|
+
- [ ] **No test deleted, skipped or weakened to make the change pass.** If one had to change, list each (name, why) in the PR description. A test edited to match new behavior proves nothing unless the old behavior was verified wrong.
|
|
21
|
+
- [ ] Tests assert behavior through the public interface, not internals.
|
|
22
|
+
|
|
23
|
+
## Refactors and rewiring
|
|
24
|
+
|
|
25
|
+
"No behavior change" holds only if you compared what the code does, not what it is called.
|
|
26
|
+
|
|
27
|
+
- [ ] Wherever a caller now points at something else, open both the old implementation (`git show <base>:<path>`) and the new one and compare what they do: synchronous or queued, what they write, what side effects and errors they have.
|
|
28
|
+
- [ ] Checks and validations still run before the side effects they protect, in the same order.
|
|
29
|
+
- [ ] Rewritten tests assert the **original** behavior, diffed against the base branch, not against the new code.
|
|
30
|
+
|
|
31
|
+
## Contracts and data
|
|
32
|
+
|
|
33
|
+
- [ ] Public API, event or schema changes are additive, or versioned with a stated migration path. List the consumers you searched.
|
|
34
|
+
- [ ] Persisted-data changes: old data still readable, rollout order safe (new code reads old data, old code survives new data).
|
|
35
|
+
- [ ] Docs, examples and catalogs that describe the changed surface are updated.
|
|
36
|
+
|
|
37
|
+
## Size
|
|
38
|
+
|
|
39
|
+
- [ ] The change is small enough to review in one sitting. If it keeps growing past your first estimate, stop and propose a split before going on. Ignore lockfiles and generated files when counting.
|
|
40
|
+
- [ ] Each PR is mergeable alone, never a broken intermediate state. Split along seams: contract, implementation, wiring, tests with their code.
|
|
41
|
+
|
|
42
|
+
## Review: two independent passes
|
|
43
|
+
|
|
44
|
+
Run both after the work, over every changed file, as if seeing it for the first time.
|
|
45
|
+
|
|
46
|
+
1. **Correctness and boundaries**: logic, edge cases, null and empty handling, module boundaries, contract compatibility, concurrency and retry safety.
|
|
47
|
+
2. **Maintainability and risk**, read again from scratch: can a newcomer follow it, is there coupling nobody mentioned, which error paths have no test, what leaks, and what did the first pass wave through.
|
|
48
|
+
|
|
49
|
+
For large changes run the `verifier` agent once per package or PR in parallel (see `parallel-work`) and merge the findings. The implementer's own pass is never enough alone.
|
|
50
|
+
|
|
51
|
+
## Report
|
|
52
|
+
|
|
53
|
+
End the task with: what changed, which gates ran and their result, what was **not** verified, any known risk. Keep it short.
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: diagnosing-bugs
|
|
3
|
+
description: Diagnosis loop for hard bugs and performance regressions. Use when the user says "diagnose"/"debug this", or reports something broken/throwing/failing/slow.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Diagnosing Bugs
|
|
7
|
+
|
|
8
|
+
A discipline for hard bugs. Skip phases only when explicitly justified.
|
|
9
|
+
|
|
10
|
+
When exploring the codebase, read `GLOSSARY.md` (if it exists) to get a clear mental model of the relevant modules, and check ADRs in the area you're touching.
|
|
11
|
+
|
|
12
|
+
## Redact
|
|
13
|
+
|
|
14
|
+
This skill has you show commands, outputs and captured artifacts. **Redact every secret first**: write `<REDACTED>` in its place. Build loops against env vars, so the credential stays in the environment rather than in what you show. Captured artifacts carry auth headers: quote only the lines that carry the signal.
|
|
15
|
+
|
|
16
|
+
If the redacted output is not enough to diagnose the bug, say so and ask the user.
|
|
17
|
+
|
|
18
|
+
## Phase 1: Build a feedback loop
|
|
19
|
+
|
|
20
|
+
**This is the skill.** Everything else is mechanical. If you have a **tight** pass/fail signal for the bug (one that goes red on _this_ bug), you will find the cause; bisection, hypothesis-testing, and instrumentation all just consume it. If you don't have one, no amount of staring at code will save you.
|
|
21
|
+
|
|
22
|
+
Spend disproportionate effort here. **Be aggressive. Be creative. Refuse to give up.**
|
|
23
|
+
|
|
24
|
+
### Ways to construct one, in roughly this order
|
|
25
|
+
|
|
26
|
+
1. **Failing test** at whatever seam reaches the bug: unit, integration, e2e.
|
|
27
|
+
2. **Curl / HTTP script** against a running dev server.
|
|
28
|
+
3. **CLI invocation** with a fixture input, diffing stdout against a known-good snapshot.
|
|
29
|
+
4. **Headless browser script** (Playwright / Puppeteer) that drives the UI and asserts on DOM/console/network.
|
|
30
|
+
5. **Replay a captured trace.** Save a real network request / payload / event log to disk; replay it through the code path in isolation.
|
|
31
|
+
6. **Throwaway harness.** Spin up a minimal subset of the system (one service, mocked deps) that exercises the bug code path with a single function call.
|
|
32
|
+
7. **Property / fuzz loop.** If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
|
|
33
|
+
8. **Bisection harness.** If the bug appeared between two known states (commit, dataset, version), automate "boot at state X, check, repeat" so you can `git bisect run` it.
|
|
34
|
+
9. **Differential loop.** Run the same input through old-version vs new-version (or two configs) and diff outputs.
|
|
35
|
+
10. **HITL bash script.** Last resort. If a human must click, drive _them_ with `scripts/hitl-loop.template.sh` so the loop is still structured. Captured output feeds back to you.
|
|
36
|
+
|
|
37
|
+
Build the right feedback loop, and the bug is 90% fixed.
|
|
38
|
+
|
|
39
|
+
### Tighten the loop
|
|
40
|
+
|
|
41
|
+
Treat the loop as a product. Once you have _a_ loop, **tighten** it:
|
|
42
|
+
|
|
43
|
+
- Can I make it faster? (Cache setup, skip unrelated init, narrow the test scope.)
|
|
44
|
+
- Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
|
|
45
|
+
- Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)
|
|
46
|
+
|
|
47
|
+
A 30-second flaky loop is barely better than no loop; a 2-second deterministic one is tight, a debugging superpower.
|
|
48
|
+
|
|
49
|
+
### Non-deterministic bugs
|
|
50
|
+
|
|
51
|
+
The goal is not a clean repro but a **higher reproduction rate**. Loop the trigger 100×, parallelise, add stress, narrow timing windows, inject sleeps. A 50%-flake bug is debuggable; 1% is not, so keep raising the rate until it's debuggable.
|
|
52
|
+
|
|
53
|
+
### When you genuinely cannot build a loop
|
|
54
|
+
|
|
55
|
+
Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a redacted captured artifact (HAR file, log dump, core dump, screen recording with timestamps), or (c) permission to add temporary production instrumentation. Do **not** proceed to hypothesise without a loop.
|
|
56
|
+
|
|
57
|
+
### Completion criterion: a tight loop that goes red
|
|
58
|
+
|
|
59
|
+
Phase 1 is done when the loop is **tight** and **red-capable**: you can name **one command** (a script path, a test invocation, a curl) that you have **already run at least once** (show the invocation and its output, redacted), and that is:
|
|
60
|
+
|
|
61
|
+
- [ ] **Red-capable**: it drives the actual bug code path and asserts the **user's exact symptom**, so it can go red on this bug and green once fixed. Not "runs without erroring"; it must be able to _catch this specific bug_.
|
|
62
|
+
- [ ] **Deterministic**: same verdict every run (flaky bugs: a pinned, high reproduction rate, per above).
|
|
63
|
+
- [ ] **Fast**: seconds, not minutes.
|
|
64
|
+
- [ ] **Agent-runnable**: you can run it unattended; a human in the loop only via `scripts/hitl-loop.template.sh`.
|
|
65
|
+
|
|
66
|
+
If you catch yourself reading code to build a theory before this command exists, **stop: jumping straight to a hypothesis is the exact failure this skill prevents.** No red-capable command, no Phase 2.
|
|
67
|
+
|
|
68
|
+
## Phase 2: Reproduce + minimise
|
|
69
|
+
|
|
70
|
+
Run the loop. Watch it go red as the bug appears.
|
|
71
|
+
|
|
72
|
+
Confirm:
|
|
73
|
+
|
|
74
|
+
- [ ] The loop produces the failure mode the **user** described, not a different failure that happens to be nearby. Wrong bug = wrong fix.
|
|
75
|
+
- [ ] The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
|
|
76
|
+
- [ ] You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.
|
|
77
|
+
|
|
78
|
+
### Minimise
|
|
79
|
+
|
|
80
|
+
Once it's red, shrink the repro to the **smallest scenario that still goes red**. Cut inputs, callers, config, data, and steps **one at a time**, re-running the loop after each cut, and keep only what's load-bearing for the failure.
|
|
81
|
+
|
|
82
|
+
Why bother: a minimal repro shrinks the hypothesis space in Phase 3 (fewer moving parts left to suspect) and becomes the clean regression test in Phase 5.
|
|
83
|
+
|
|
84
|
+
Done when **every remaining element is load-bearing**: removing any one of them makes the loop go green.
|
|
85
|
+
|
|
86
|
+
Do not proceed until you have reproduced **and** minimised.
|
|
87
|
+
|
|
88
|
+
## Phase 3: Hypothesise
|
|
89
|
+
|
|
90
|
+
Generate **3–5 ranked hypotheses** before testing any of them. Single-hypothesis generation anchors on the first plausible idea.
|
|
91
|
+
|
|
92
|
+
Each hypothesis must be **falsifiable**: state the prediction it makes.
|
|
93
|
+
|
|
94
|
+
> Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."
|
|
95
|
+
|
|
96
|
+
If you cannot state the prediction, the hypothesis is a vibe: discard or sharpen it.
|
|
97
|
+
|
|
98
|
+
**Show the ranked list to the user before testing.** They often have domain knowledge that re-ranks instantly ("we just deployed a change to #3"), or know hypotheses they've already ruled out. Cheap checkpoint, big time saver. Don't block on it; proceed with your ranking if the user is AFK.
|
|
99
|
+
|
|
100
|
+
## Phase 4: Instrument
|
|
101
|
+
|
|
102
|
+
Each probe must map to a specific prediction from Phase 3. **Change one variable at a time.**
|
|
103
|
+
|
|
104
|
+
Tool preference:
|
|
105
|
+
|
|
106
|
+
1. **Debugger / REPL inspection** if the env supports it. One breakpoint beats ten logs.
|
|
107
|
+
2. **Targeted logs** at the boundaries that distinguish hypotheses.
|
|
108
|
+
3. Never "log everything and grep".
|
|
109
|
+
|
|
110
|
+
**Tag every debug log** with a unique prefix, e.g. `[DEBUG-a4f2]`. Cleanup at the end becomes a single grep. Untagged logs survive; tagged logs die.
|
|
111
|
+
|
|
112
|
+
**Perf branch.** For performance regressions, logs are usually wrong. Instead: establish a baseline measurement (timing harness, `performance.now()`, profiler, query plan), then bisect. Measure first, fix second.
|
|
113
|
+
|
|
114
|
+
## Phase 5: Fix + regression test
|
|
115
|
+
|
|
116
|
+
Write the regression test **before the fix**, but only if there is a **correct seam** for it.
|
|
117
|
+
|
|
118
|
+
A correct seam is one where the test exercises the **real bug pattern** as it occurs at the call site. If the only available seam is too shallow (single-caller test when the bug needs multiple callers, unit test that can't replicate the chain that triggered the bug), a regression test there gives false confidence.
|
|
119
|
+
|
|
120
|
+
**If no correct seam exists, that itself is the finding.** Note it. The codebase architecture is preventing the bug from being locked down. Flag this for the next phase.
|
|
121
|
+
|
|
122
|
+
If a correct seam exists:
|
|
123
|
+
|
|
124
|
+
1. Turn the minimised repro into a failing test at that seam.
|
|
125
|
+
2. Watch it fail. If you forced the red by mutating code or a fixture, `diff` against a pristine copy to prove the mutation landed before you trust it.
|
|
126
|
+
3. Apply the fix.
|
|
127
|
+
4. Watch it pass.
|
|
128
|
+
5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.
|
|
129
|
+
|
|
130
|
+
## Phase 6: Cleanup
|
|
131
|
+
|
|
132
|
+
Required before declaring done:
|
|
133
|
+
|
|
134
|
+
- [ ] Original repro no longer reproduces (re-run the Phase 1 loop)
|
|
135
|
+
- [ ] Regression test passes (or absence of seam is documented)
|
|
136
|
+
- [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
|
|
137
|
+
- [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
|
|
138
|
+
- [ ] The hypothesis that turned out correct is stated in the commit / PR message, so the next debugger learns
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
# Human-in-the-loop reproduction loop.
|
|
3
|
+
# Copy this file, edit the steps below, and run it.
|
|
4
|
+
# The agent runs the script; the user follows prompts in their terminal.
|
|
5
|
+
#
|
|
6
|
+
# Usage:
|
|
7
|
+
# bash hitl-loop.template.sh
|
|
8
|
+
#
|
|
9
|
+
# Two helpers:
|
|
10
|
+
# step "<instruction>" → show instruction, wait for Enter
|
|
11
|
+
# capture VAR "<question>" → show question, read response into VAR
|
|
12
|
+
#
|
|
13
|
+
# At the end, captured values are printed as KEY=VALUE for the agent to parse.
|
|
14
|
+
#
|
|
15
|
+
# `capture` prints its value back to the terminal, where the agent reads it,
|
|
16
|
+
# so capture observations, and leave signing in to the user as a `step`.
|
|
17
|
+
|
|
18
|
+
set -euo pipefail
|
|
19
|
+
|
|
20
|
+
step() {
|
|
21
|
+
printf '\n>>> %s\n' "$1"
|
|
22
|
+
read -r -p " [Enter when done] " _
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
capture() {
|
|
26
|
+
local var="$1" question="$2" answer
|
|
27
|
+
printf '\n>>> %s\n' "$question"
|
|
28
|
+
read -r -p " > " answer
|
|
29
|
+
printf -v "$var" '%s' "$answer"
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
# --- edit below ---------------------------------------------------------
|
|
33
|
+
|
|
34
|
+
step "Open the app at http://localhost:3000 and sign in."
|
|
35
|
+
|
|
36
|
+
capture ERRORED "Click the 'Export' button. Did it throw an error? (y/n)"
|
|
37
|
+
|
|
38
|
+
capture ERROR_MSG "Paste the error message (or 'none'):"
|
|
39
|
+
|
|
40
|
+
# --- edit above ---------------------------------------------------------
|
|
41
|
+
|
|
42
|
+
printf '\n--- Captured ---\n'
|
|
43
|
+
printf 'ERRORED=%s\n' "$ERRORED"
|
|
44
|
+
printf 'ERROR_MSG=%s\n' "$ERROR_MSG"
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# ADR Format
|
|
2
|
+
|
|
3
|
+
ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
|
|
4
|
+
|
|
5
|
+
Create the `docs/adr/` directory lazily: only when the first ADR is needed.
|
|
6
|
+
|
|
7
|
+
## Template
|
|
8
|
+
|
|
9
|
+
```md
|
|
10
|
+
# {Short title of the decision}
|
|
11
|
+
|
|
12
|
+
{1-3 sentences: what's the context, what did we decide, and why.}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why*, not in filling out sections.
|
|
16
|
+
|
|
17
|
+
## Optional sections
|
|
18
|
+
|
|
19
|
+
Only include these when they add genuine value. Most ADRs won't need them.
|
|
20
|
+
|
|
21
|
+
- **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`): useful when decisions are revisited
|
|
22
|
+
- **Considered Options**: only when the rejected alternatives are worth remembering
|
|
23
|
+
- **Consequences**: only when non-obvious downstream effects need to be called out
|
|
24
|
+
|
|
25
|
+
## Numbering
|
|
26
|
+
|
|
27
|
+
Scan `docs/adr/` for the highest existing number and increment by one.
|
|
28
|
+
|
|
29
|
+
## When to offer an ADR
|
|
30
|
+
|
|
31
|
+
All three of these must be true:
|
|
32
|
+
|
|
33
|
+
1. **Hard to reverse**: the cost of changing your mind later is meaningful
|
|
34
|
+
2. **Surprising without context**: a future reader will look at the code and wonder "why on earth did they do it this way?"
|
|
35
|
+
3. **The result of a real trade-off**: there were genuine alternatives and you picked one for specific reasons
|
|
36
|
+
|
|
37
|
+
If a decision is easy to reverse, skip it: you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."
|
|
38
|
+
|
|
39
|
+
### What qualifies
|
|
40
|
+
|
|
41
|
+
- **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
|
|
42
|
+
- **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
|
|
43
|
+
- **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library: just the ones that would take a quarter to swap out.
|
|
44
|
+
- **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
|
|
45
|
+
- **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
|
|
46
|
+
- **Constraints not visible in the code.** "We can't use a public cloud because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
|
|
47
|
+
- **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it; otherwise someone will suggest GraphQL again in six months.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# GLOSSARY.md Format
|
|
2
|
+
|
|
3
|
+
## Structure
|
|
4
|
+
|
|
5
|
+
```md
|
|
6
|
+
# {Context Name}
|
|
7
|
+
|
|
8
|
+
{One or two sentence description of what this context is and why it exists.}
|
|
9
|
+
|
|
10
|
+
## Language
|
|
11
|
+
|
|
12
|
+
**Order**:
|
|
13
|
+
{A one or two sentence description of the term}
|
|
14
|
+
_Avoid_: Booking, transaction
|
|
15
|
+
|
|
16
|
+
**Receipt**:
|
|
17
|
+
A confirmation of payment sent to a customer after delivery.
|
|
18
|
+
_Avoid_: Bill, proof
|
|
19
|
+
|
|
20
|
+
**Customer**:
|
|
21
|
+
A person or organization that places orders.
|
|
22
|
+
_Avoid_: Client, buyer, account
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Rules
|
|
26
|
+
|
|
27
|
+
- **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others under `_Avoid_`.
|
|
28
|
+
- **Keep definitions tight.** One or two sentences max. Define what it IS, not what it does.
|
|
29
|
+
- **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
|
|
30
|
+
- **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
|
|
31
|
+
|
|
32
|
+
## Single vs multi-context repos
|
|
33
|
+
|
|
34
|
+
**Single context (most repos):** One `GLOSSARY.md` at the repo root.
|
|
35
|
+
|
|
36
|
+
**Multiple contexts:** A `GLOSSARY-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:
|
|
37
|
+
|
|
38
|
+
```md
|
|
39
|
+
# Glossary Map
|
|
40
|
+
|
|
41
|
+
## Contexts
|
|
42
|
+
|
|
43
|
+
- [Ordering](./src/ordering/GLOSSARY.md): receives and tracks customer orders
|
|
44
|
+
- [Billing](./src/billing/GLOSSARY.md): generates receipts and processes payments
|
|
45
|
+
- [Fulfillment](./src/fulfillment/GLOSSARY.md): manages warehouse picking and shipping
|
|
46
|
+
|
|
47
|
+
## Relationships
|
|
48
|
+
|
|
49
|
+
- **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
|
|
50
|
+
- **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate receipts
|
|
51
|
+
- **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
The skill infers which structure applies:
|
|
55
|
+
|
|
56
|
+
- If `GLOSSARY-MAP.md` exists, read it to find contexts
|
|
57
|
+
- If only a root `GLOSSARY.md` exists, single context
|
|
58
|
+
- If neither exists, create a root `GLOSSARY.md` lazily when the first term is resolved
|
|
59
|
+
|
|
60
|
+
When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: domain-modeling
|
|
3
|
+
description: Build and sharpen a project's domain model. Use when discussing codebase terminology, writing or editing a GLOSSARY.md, or recording or editing an ADR.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Domain Modeling
|
|
7
|
+
|
|
8
|
+
Actively build and sharpen the project's domain model as you design. This is the *active* discipline: challenging terms, inventing edge-case scenarios, and writing the glossary and decisions down the moment they crystallise. (Merely *reading* `GLOSSARY.md` for vocabulary is not this skill: that's a one-line habit any skill can do. This skill is for when you're changing the model, not just consuming it.)
|
|
9
|
+
|
|
10
|
+
## File structure
|
|
11
|
+
|
|
12
|
+
Most repos have a single context:
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
/
|
|
16
|
+
├── GLOSSARY.md
|
|
17
|
+
├── docs/
|
|
18
|
+
│ └── adr/
|
|
19
|
+
│ ├── 0001-event-sourced-orders.md
|
|
20
|
+
│ └── 0002-postgres-for-write-model.md
|
|
21
|
+
└── src/
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
If a `GLOSSARY-MAP.md` exists at the root, the repo has multiple contexts. The map points to where each one lives:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
/
|
|
28
|
+
├── GLOSSARY-MAP.md
|
|
29
|
+
├── docs/
|
|
30
|
+
│ └── adr/ ← system-wide decisions
|
|
31
|
+
├── src/
|
|
32
|
+
│ ├── ordering/
|
|
33
|
+
│ │ ├── GLOSSARY.md
|
|
34
|
+
│ │ └── docs/adr/ ← context-specific decisions
|
|
35
|
+
│ └── billing/
|
|
36
|
+
│ ├── GLOSSARY.md
|
|
37
|
+
│ └── docs/adr/
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Create files lazily: only when you have something to write. If no `GLOSSARY.md` exists, create one when the first term is resolved. If no `docs/adr/` exists, create it when the first ADR is needed.
|
|
41
|
+
|
|
42
|
+
## During the session
|
|
43
|
+
|
|
44
|
+
### Challenge against the glossary
|
|
45
|
+
|
|
46
|
+
When the user uses a term that conflicts with the existing language in `GLOSSARY.md`, call it out immediately. "Your glossary defines 'cancellation' as X, but you seem to mean Y. Which is it?"
|
|
47
|
+
|
|
48
|
+
### Sharpen fuzzy language
|
|
49
|
+
|
|
50
|
+
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."
|
|
51
|
+
|
|
52
|
+
### Discuss concrete scenarios
|
|
53
|
+
|
|
54
|
+
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.
|
|
55
|
+
|
|
56
|
+
### Cross-reference with code
|
|
57
|
+
|
|
58
|
+
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?"
|
|
59
|
+
|
|
60
|
+
### Update GLOSSARY.md inline
|
|
61
|
+
|
|
62
|
+
When a term is resolved, update `GLOSSARY.md` right there. Don't batch these up: capture them as they happen. Use the format in [GLOSSARY-FORMAT.md](./GLOSSARY-FORMAT.md).
|
|
63
|
+
|
|
64
|
+
`GLOSSARY.md` should be totally devoid of implementation details. Do not treat `GLOSSARY.md` as a spec, a scratch pad, or a repository for implementation decisions. It is a glossary and nothing else.
|
|
65
|
+
|
|
66
|
+
### Offer ADRs sparingly
|
|
67
|
+
|
|
68
|
+
Only offer to create an ADR when all three are true:
|
|
69
|
+
|
|
70
|
+
1. **Hard to reverse**: the cost of changing your mind later is meaningful
|
|
71
|
+
2. **Surprising without context**: a future reader will wonder "why did they do it this way?"
|
|
72
|
+
3. **The result of a real trade-off**: there were genuine alternatives and you picked one for specific reasons
|
|
73
|
+
|
|
74
|
+
If any of the three is missing, skip the ADR. Use the format in [ADR-FORMAT.md](./ADR-FORMAT.md).
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ground-truth
|
|
3
|
+
description: "No guessing: verify every claim against the source before relying on it or stating it. Use before using an API, flag, file, schema, version, event shape or model name you have not seen in this session, and before saying something works, passes or is done."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Ground truth
|
|
7
|
+
|
|
8
|
+
A claim is either **verified** (you saw it in this session) or **unverified** (you remember it, inferred it, or it looks right). Only verified claims go into code, plans and answers. Unverified ones get verified or labelled.
|
|
9
|
+
|
|
10
|
+
## Before you rely on a thing
|
|
11
|
+
|
|
12
|
+
| You are about to rely on | Verify by |
|
|
13
|
+
|---|---|
|
|
14
|
+
| A function, type, export, flag | Open its definition. Do not trust the name. |
|
|
15
|
+
| A file or path | List or read it. |
|
|
16
|
+
| A payload, schema, event or DB column | Read the producer and the consumer, or the migration. Never infer a shape from a sibling. |
|
|
17
|
+
| A dependency API | Read the installed version's types or docs, not memory. A new version may have changed it. |
|
|
18
|
+
| A command or script | Read it in the manifest (`package.json`, `Makefile`). Run it. |
|
|
19
|
+
| A model name or config key | List what the tool accepts (its model picker, CLI help, docs). An unknown value often falls back silently. |
|
|
20
|
+
| A function that "does the same" as the one you replace | Read both bodies. Same name is not same behavior. |
|
|
21
|
+
| "It was like that before" | `git show <ref>:<path>` |
|
|
22
|
+
|
|
23
|
+
If you cannot verify: say so, name what is missing, ask or choose the reversible option. Never fill the gap with a plausible guess.
|
|
24
|
+
|
|
25
|
+
## Before you say it is done
|
|
26
|
+
|
|
27
|
+
- You ran the check, on the final state of the code, and you read its output. "Should pass" is not a result.
|
|
28
|
+
- A green run only counts if it covers the claim: a one-file test does not prove the whole package.
|
|
29
|
+
- State what you did not run or could not check. One line.
|
|
30
|
+
|
|
31
|
+
## Evidence format
|
|
32
|
+
|
|
33
|
+
Cite the place: `path/to/file.ts:42`, a command and its exit code, or a link. A claim without a place is a guess.
|
|
34
|
+
|
|
35
|
+
## Search, then read
|
|
36
|
+
|
|
37
|
+
1. Search narrowly (symbol, string, path) to find candidates.
|
|
38
|
+
2. Read only the matching range of each file.
|
|
39
|
+
3. When two sources disagree, the code that runs beats docs, which beat comments, which beat memory. Report the conflict.
|
|
40
|
+
|
|
41
|
+
## Red flags in your own output
|
|
42
|
+
|
|
43
|
+
- "Probably", "should", "I believe", "usually" next to a fact you could check.
|
|
44
|
+
- A name you typed from memory: import path, option, CLI flag, header, enum value.
|
|
45
|
+
- A version number, URL or id you did not just read.
|
|
46
|
+
- A test you updated to match new behavior without checking the old behavior was wrong.
|
|
47
|
+
|
|
48
|
+
## Subagents
|
|
49
|
+
|
|
50
|
+
A subagent's report is a claim, not evidence. When it drives a decision, open the cited file yourself. Brief subagents to return `file:line` for every finding.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: handoff
|
|
3
|
+
description: Compact the current conversation into a handoff document for another agent to pick up.
|
|
4
|
+
argument-hint: "What will the next session be used for?"
|
|
5
|
+
disable-model-invocation: true
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Write a handoff document summarising the current conversation so a fresh agent can continue the work. Save to the temporary directory of the user's OS (`$TMPDIR`, else `/tmp`; `%TEMP%` on Windows) - not the current workspace.
|
|
9
|
+
|
|
10
|
+
Include a "suggested skills" section in the document, naming which skills the next agent should call the Skill tool for.
|
|
11
|
+
|
|
12
|
+
Do not duplicate content already captured in other artifacts (specs, plans, ADRs, issues, commits, diffs). Reference them by path or URL instead.
|
|
13
|
+
|
|
14
|
+
Redact any sensitive information, such as API keys, passwords, or personally identifiable information.
|
|
15
|
+
|
|
16
|
+
If the user passed arguments, treat them as a description of what the next session will focus on and tailor the doc accordingly.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: implement
|
|
3
|
+
description: "Implement a piece of work based on a spec or set of tickets."
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Implement the work described by the user in the spec or tickets.
|
|
8
|
+
|
|
9
|
+
Refuse a missing or unchallenged plan: run `challenge` (or `plan`, when there is nothing yet) first.
|
|
10
|
+
|
|
11
|
+
If the user passes a ticket reference, fetch it from the issue tracker and state its title before starting. If the reference is ambiguous, ask.
|
|
12
|
+
|
|
13
|
+
Before writing code, climb the `ponytail-review` ladder for every new piece
|
|
14
|
+
of code, file, or dependency — need to exist? in this codebase? standard
|
|
15
|
+
library? native platform feature or a standard tool? installed dependency?
|
|
16
|
+
one line? else the minimum code that works — and stop at the first rung that
|
|
17
|
+
holds. Stop and replan any piece where a higher rung holds.
|
|
18
|
+
|
|
19
|
+
Call the Skill tool with "tdd" where possible, at pre-agreed seams.
|
|
20
|
+
|
|
21
|
+
Run typechecking regularly, single test files regularly, and the full test suite once at the end.
|
|
22
|
+
|
|
23
|
+
Then pass `definition-of-done`, and call the Skill tool with "review" to review the work.
|
|
24
|
+
|
|
25
|
+
Commit your work to the current branch.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: implement-spec
|
|
3
|
+
description: "Implement the result of /to-spec and /to-tickets in code."
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
You have been provided a spec. This spec should have tickets associated with it, describing how to implement the spec.
|
|
8
|
+
|
|
9
|
+
The issue tracker should have been provided to you. If not, tell the user to run `/setup-matt-pocock-skills`.
|
|
10
|
+
|
|
11
|
+
The goal is the entire spec implemented on a single **integration branch**, with every ticket resolved the way the issue tracker closes work.
|
|
12
|
+
|
|
13
|
+
The tickets are not a list of steps. They are a **task graph** with blocking relationships between them. This means there is always a **frontier** of tickets which are ready to be grabbed.
|
|
14
|
+
|
|
15
|
+
Communication to and from subagents should be sparse. Communicate primarily through **context pointers**: to the spec, tickets, research notes, and previous commits. Don't duplicate information already available via pointers.
|
|
16
|
+
|
|
17
|
+
**Implementer subagents** should be run in the background where possible for maximum concurrency.
|
|
18
|
+
|
|
19
|
+
## Steps
|
|
20
|
+
|
|
21
|
+
1. Read the spec and tickets to understand the task graph.
|
|
22
|
+
|
|
23
|
+
2. (optional) Use an **exploration subagent** to conduct any exploration required by the tickets - relevant codebase files or external documentation. Ensure the exploration subagent can save files - it should save its markdown notes in a directory outside the repo, accessible by all future subagents. This lets **implementer subagents** focus on implementation rather than exploration.
|
|
24
|
+
|
|
25
|
+
3. Create the integration branch. If the issue tracker closes work through PRs, or the user asks for one, open a draft PR after the first merge in step 5 (a branch with no commits ahead of main can't open one), marked as closing the spec and tickets.
|
|
26
|
+
|
|
27
|
+
4. Use **implementer subagents** to implement each ticket, each in its own worktree on its own branch. Each implementer subagent:
|
|
28
|
+
- confirms its worktree is based on the integration branch before starting, and resets onto it if not;
|
|
29
|
+
- re-asks the `ponytail-review` ladder before writing each piece, and
|
|
30
|
+
stops and replans the ticket if a higher rung holds;
|
|
31
|
+
- calls the Skill tool with `tdd` to build the ticket;
|
|
32
|
+
- merges the integration branch tip into its own branch before reporting done
|
|
33
|
+
|
|
34
|
+
5. Once an **implementer subagent** completes, merge its work to the integration branch with a **merger subagent**.
|
|
35
|
+
|
|
36
|
+
6. If this changes the **frontier** of available tickets, kick off more **implementer subagents** to work on the new tickets. This allows for maximum concurrency.
|
|
37
|
+
|
|
38
|
+
7. Once all tickets are complete, call the Skill tool with `code-review` on the integration branch. Fix all issues raised by the code review in a single **implementer subagent**.
|
|
39
|
+
|
|
40
|
+
8. If a draft PR exists, mark it ready for review. Otherwise, resolve each ticket the way the issue tracker closes work, and report the integration branch.
|
|
41
|
+
|
|
42
|
+
9. Clean up all **implementer subagent** worktrees.
|