@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,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ponytail-help
|
|
3
|
+
description: >
|
|
4
|
+
Quick reference for ponytail levels, skills and commands. One-shot display.
|
|
5
|
+
Use for /ponytail-help, "ponytail help", "how do I use ponytail".
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Ponytail Help
|
|
9
|
+
|
|
10
|
+
Display this reference card when invoked. One-shot, do NOT change mode,
|
|
11
|
+
write flag files, or persist anything.
|
|
12
|
+
|
|
13
|
+
## Levels
|
|
14
|
+
|
|
15
|
+
| Level | Trigger | What change |
|
|
16
|
+
|-------|---------|-------------|
|
|
17
|
+
| **Lite** | `/ponytail lite` | Build what was asked, name the smaller option in one line. |
|
|
18
|
+
| **Full** | `/ponytail` | The smallest complete change, a check where the logic needs one, and a reply that names what was skipped and any risk. Default. |
|
|
19
|
+
| **Ultra** | `/ponytail ultra` | Also questions the request and pushes back before building. |
|
|
20
|
+
|
|
21
|
+
Level sticks until changed or session end.
|
|
22
|
+
|
|
23
|
+
## Skills
|
|
24
|
+
|
|
25
|
+
| Skill | Trigger | What it does |
|
|
26
|
+
|-------|---------|--------------|
|
|
27
|
+
| **ponytail** | `/ponytail` | Lazy mode itself: least new code, clear replies that name skipped work and risks. |
|
|
28
|
+
| **ponytail-review** | `/ponytail-review` | Quality review of a diff: bugs, security, load, missing tests, speed, what to cut. Each finding says what goes wrong and how to fix it. |
|
|
29
|
+
| **ponytail-audit** | `/ponytail-audit` | The same quality review for the whole repo, ranked. |
|
|
30
|
+
| **ponytail-debt** | `/ponytail-debt` | Harvest `shortcut:` comments into a tracked ledger. |
|
|
31
|
+
| **ponytail-gain** | `/ponytail-gain` | Measured-impact scoreboard: less code, less cost, more speed. |
|
|
32
|
+
| **ponytail-help** | `/ponytail-help` | This card. |
|
|
33
|
+
|
|
34
|
+
In Codex CLI and the IDE extension, invoke skills with `$ponytail:ponytail`,
|
|
35
|
+
`$ponytail:ponytail-review`, or `$ponytail:ponytail-help`. Claude Code and OpenCode use the
|
|
36
|
+
slash-command forms above (OpenCode ships all six as slash commands).
|
|
37
|
+
|
|
38
|
+
## Deactivate
|
|
39
|
+
|
|
40
|
+
Say "stop ponytail" or "normal mode". Resume anytime with `/ponytail`.
|
|
41
|
+
`/ponytail off` also works.
|
|
42
|
+
|
|
43
|
+
## Band (Claude Code)
|
|
44
|
+
|
|
45
|
+
`/ponytail band` hides the band above the prompt, the same command brings it back.
|
|
46
|
+
`/ponytail band on` and `/ponytail band off` set it directly. The level stays.
|
|
47
|
+
`/ponytail band import` adds your past Claude Code sessions (cost, agent time, tokens) to the board.
|
|
48
|
+
|
|
49
|
+
## Configure Default Mode
|
|
50
|
+
|
|
51
|
+
Default mode = `full`, auto-active every session. Change it:
|
|
52
|
+
|
|
53
|
+
**Environment variable** (highest priority):
|
|
54
|
+
```bash
|
|
55
|
+
export PONYTAIL_DEFAULT_MODE=ultra
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Config file** (`~/.config/ponytail/config.json`, Windows: `%APPDATA%\ponytail\config.json`):
|
|
59
|
+
```json
|
|
60
|
+
{ "defaultMode": "lite" }
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Set `"off"` to disable auto-activation on session start, activate manually
|
|
64
|
+
with `/ponytail` when wanted.
|
|
65
|
+
|
|
66
|
+
Resolution: env var > config file > `full`.
|
|
67
|
+
|
|
68
|
+
## Update
|
|
69
|
+
|
|
70
|
+
Enable auto-update once: open `/plugin`, go to Marketplaces, pick ponytail, Enable auto-update. Claude Code then pulls new versions at startup (run `/reload-plugins` when it prompts). Manual refresh: `/plugin marketplace update ponytail` then `/reload-plugins`.
|
|
71
|
+
|
|
72
|
+
If `/plugin` is not recognized, your Claude Code is out of date. Update it (`npm install -g @anthropic-ai/claude-code@latest`, or `brew upgrade claude-code`) and restart. Other hosts use their own update flow.
|
|
73
|
+
|
|
74
|
+
## More
|
|
75
|
+
|
|
76
|
+
Full docs + examples: https://github.com/DietrichGebert/ponytail
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ponytail-review
|
|
3
|
+
description: >
|
|
4
|
+
Quality review of a change: is the logic right, is it safe, does it hold
|
|
5
|
+
under real load, is risky code tested, is it fast enough, and is every line
|
|
6
|
+
needed. Reads the connected code, not only the diff. Each finding is
|
|
7
|
+
explained in plain English. Use for "review this", "code review", "review
|
|
8
|
+
the last commit", "review my PR", "is this over-engineered", /ponytail-review.
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
Review a change like the senior developer who will be paged when it breaks.
|
|
12
|
+
Order of importance: correct, safe, holds under load, tested, fast, lean.
|
|
13
|
+
Lean still matters: every extra line must be read, tested and fixed later.
|
|
14
|
+
This is a report the user asked for, so give it in full.
|
|
15
|
+
|
|
16
|
+
## 1. The ladder: does this code deserve to exist?
|
|
17
|
+
|
|
18
|
+
For every piece of new code, new file, or new dependency in the diff,
|
|
19
|
+
climb down and stop at the first rung that holds. Name the rung.
|
|
20
|
+
A piece that skipped a higher rung is a finding.
|
|
21
|
+
|
|
22
|
+
1. Does this need to exist at all? Skip what nobody asked for; say so in
|
|
23
|
+
one line.
|
|
24
|
+
2. Already in this codebase? Reuse the helper, component, service, pattern.
|
|
25
|
+
3. Does the standard library do it? Use it.
|
|
26
|
+
4. Does a native platform feature or a standard tool cover it? A DB
|
|
27
|
+
constraint beats app code; a CLI generator beats hand-written files.
|
|
28
|
+
5. Does an already-installed dependency solve it? Never add one for a few
|
|
29
|
+
lines.
|
|
30
|
+
6. Can it be one line a reader gets at a glance? One line.
|
|
31
|
+
7. Only then: the minimum code that works.
|
|
32
|
+
|
|
33
|
+
## 2. Understand first
|
|
34
|
+
|
|
35
|
+
- Review what the user names: uncommitted or staged changes, a branch, a PR
|
|
36
|
+
link, or files. Nothing named: the uncommitted changes, or the last commit
|
|
37
|
+
if there are none.
|
|
38
|
+
- Read the diff, then the code it touches: callers of every changed function,
|
|
39
|
+
the functions it calls, the tests, the README.
|
|
40
|
+
- Trace the real flow: where data comes in, what is stored, what goes out.
|
|
41
|
+
- A change can break code it does not touch. When a signature, return value
|
|
42
|
+
or behavior changes, grep every caller.
|
|
43
|
+
- Find the expected load in the repo (README, deploy config): one person
|
|
44
|
+
running a script, or many users and processes at once. Judge scale against
|
|
45
|
+
that, and say which load you assumed.
|
|
46
|
+
|
|
47
|
+
## 3. Look for
|
|
48
|
+
|
|
49
|
+
1. **Bug:** wrong result, crash, missed edge case (empty, zero, last item,
|
|
50
|
+
rounding, time zones), a caller broken by the change, a fix applied in one
|
|
51
|
+
caller while the shared function stays broken.
|
|
52
|
+
2. **Risk:** security holes (injection, weak randomness, secrets, missing
|
|
53
|
+
checks on input from users), data loss (errors swallowed, writes in the
|
|
54
|
+
wrong order, no transaction).
|
|
55
|
+
3. **Scale:** fine for one user, wrong for many: check-then-write races, the
|
|
56
|
+
same work done by every process, memory or lists that only grow, a query
|
|
57
|
+
per item, O(n^2) on big input, per-process state that must be shared.
|
|
58
|
+
4. **Missing test:** risky new logic (a branch, a parser, money, security,
|
|
59
|
+
data writes, a bug fix) with no test that fails when it breaks. One good
|
|
60
|
+
test, not coverage.
|
|
61
|
+
5. **Speed:** big slowdowns are problems. Small wins (work repeated in a hot
|
|
62
|
+
loop) are suggestions; some software counts every millisecond.
|
|
63
|
+
6. **Lean:** code that should not exist or should be smaller. Climb the
|
|
64
|
+
ladder in section 1 first and name the first rung that holds.
|
|
65
|
+
- delete: dead code, unused options, speculative features
|
|
66
|
+
- reuse: the repo already has this helper (name the path)
|
|
67
|
+
- stdlib / native: the standard library or platform already does it; a
|
|
68
|
+
new dependency for a few lines
|
|
69
|
+
- yagni: abstraction with one implementation, config nobody sets
|
|
70
|
+
- merge: near-copies that must change together
|
|
71
|
+
- split: one function doing several unrelated jobs, so it is hard to read
|
|
72
|
+
or test. Split by job, never by line count, and never into helpers that
|
|
73
|
+
exist only to make a function shorter.
|
|
74
|
+
|
|
75
|
+
## 4. Check before you report
|
|
76
|
+
|
|
77
|
+
- Every finding needs a concrete case: "this input or situation leads to this
|
|
78
|
+
wrong result". No case, no finding.
|
|
79
|
+
- Re-read the lines and confirm: the caller exists, the value can really be
|
|
80
|
+
empty, the code really is unused.
|
|
81
|
+
- A shortcut marked with a `shortcut:` (or older `ponytail:`) comment that names its limit is a
|
|
82
|
+
decision, not a finding, unless the expected load already crosses it.
|
|
83
|
+
- Propose the smallest fix that works. Prefer fixes that delete code. Never
|
|
84
|
+
add layers, frameworks or config the problem does not need.
|
|
85
|
+
- No style taste, no "consider", no vague worries.
|
|
86
|
+
|
|
87
|
+
## 5. Output
|
|
88
|
+
|
|
89
|
+
Very simple English: short sentences, everyday words. Explain a technical
|
|
90
|
+
term the first time you use it. The reader may never have seen this code.
|
|
91
|
+
|
|
92
|
+
Start with `What this change does:` in two or three sentences.
|
|
93
|
+
|
|
94
|
+
Then the findings in three groups, skip empty groups:
|
|
95
|
+
- **Must fix:** bug, security, data loss, breaks at the expected load.
|
|
96
|
+
- **Should fix:** risky code without a test, real slowness, duplication, a
|
|
97
|
+
function that mixes jobs, code that should not exist.
|
|
98
|
+
- **Nice to have:** small speed-ups, shorter forms.
|
|
99
|
+
|
|
100
|
+
Number findings across all groups, so the user can say "fix 2 and 5".
|
|
101
|
+
Every finding has all four parts, each one or two short sentences:
|
|
102
|
+
|
|
103
|
+
2. **Orders land on the wrong day** (`billing/close_day.py:L40-52`)
|
|
104
|
+
- **What this is:** At midnight this job closes the day and bills all orders of that day.
|
|
105
|
+
- **Problem:** It takes "today" from the server clock, which runs in UTC. An order placed
|
|
106
|
+
at 00:30 in Berlin is billed on the day before.
|
|
107
|
+
- **Fix:** Compute the day once in the shop's time zone:
|
|
108
|
+
`datetime.now(ZoneInfo("Europe/Berlin")).date()`. One line, nothing else changes.
|
|
109
|
+
- **If we skip it:** Late orders show the wrong date, and accounting fixes them by hand.
|
|
110
|
+
|
|
111
|
+
End with:
|
|
112
|
+
- `Verdict: Ship.` or `Verdict: fix 1 and 3 first.`
|
|
113
|
+
- `Lean: -<N> lines possible.` when lean findings exist.
|
|
114
|
+
- `Not checked:` one line, if something mattered and you could not check it.
|
|
115
|
+
|
|
116
|
+
Nothing found: `What this change does:`, then `Looks good. Ship.` and one line
|
|
117
|
+
on what you checked.
|
|
118
|
+
|
|
119
|
+
Lists findings, changes no code.
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
# Credits
|
|
2
|
+
|
|
3
|
+
The **Summary** section's menu of visuals (pseudocode, call trees, component trees, file trees, Mermaid, diffs) and its placement guidance come from [Dex Horthy](https://github.com/dexhorthy)'s [`show-me`](https://github.com/humanlayer/humanlayer) skill, reproduced almost word for word and aimed at a diff instead of a live conversation. `pr` does not depend on `show-me` as a skill (it isn't part of this repo, and a hard dependency would break standalone installs), so the content is copied in rather than pointed at; this file is the attribution a dependency would otherwise have carried.
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: pr
|
|
3
|
+
description: "Use when writing a PR body."
|
|
4
|
+
metadata:
|
|
5
|
+
credits:
|
|
6
|
+
skill: show-me
|
|
7
|
+
author: Dex Horthy
|
|
8
|
+
organisation: Humanlayer
|
|
9
|
+
url: "https://github.com/humanlayer/skills/blob/main/plugins/show-me/skills/show-me/SKILL.md"
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
Use this template for writing the PR body:
|
|
13
|
+
|
|
14
|
+
```markdown
|
|
15
|
+
## Summary
|
|
16
|
+
|
|
17
|
+
<diagram, diff-sketch, or tree>
|
|
18
|
+
|
|
19
|
+
## Evidence
|
|
20
|
+
|
|
21
|
+
- **Before:** <screenshot/output/failing test run>
|
|
22
|
+
**After:** <screenshot/output/passing test run>
|
|
23
|
+
|
|
24
|
+
## Merge Danger
|
|
25
|
+
|
|
26
|
+
**Door:** <one-way or two-way>
|
|
27
|
+
|
|
28
|
+
<optional: description>
|
|
29
|
+
|
|
30
|
+
**Blast Radius:** <one-word description>
|
|
31
|
+
|
|
32
|
+
<optional: potential ramifications of merge>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Sections
|
|
36
|
+
|
|
37
|
+
Skip all preambles and keep prose brief. Use the user's domain language from `GLOSSARY.md`.
|
|
38
|
+
|
|
39
|
+
### Summary
|
|
40
|
+
|
|
41
|
+
Pick the smallest view that makes the key point clear.
|
|
42
|
+
|
|
43
|
+
- Show logic or an algorithm as pseudocode:
|
|
44
|
+
|
|
45
|
+
```text
|
|
46
|
+
on(save)
|
|
47
|
+
if content is unchanged
|
|
48
|
+
return cached result
|
|
49
|
+
write new content
|
|
50
|
+
return fresh result
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
- Show runtime control flow as a call tree:
|
|
54
|
+
|
|
55
|
+
```text
|
|
56
|
+
submitForm
|
|
57
|
+
createSession
|
|
58
|
+
persistPrompt
|
|
59
|
+
launchAgent
|
|
60
|
+
navigateToSession
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
- Show UI structure as a component tree, including state and module boundaries that matter:
|
|
64
|
+
|
|
65
|
+
```text
|
|
66
|
+
<SessionPage> (apps/example/src/routes/session.tsx)
|
|
67
|
+
useSessionEvents()
|
|
68
|
+
<SessionToolbar>
|
|
69
|
+
<RunSkillButton> (packages/ui)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
- Show file responsibility or a broad refactor as a shallow file tree:
|
|
73
|
+
|
|
74
|
+
```text
|
|
75
|
+
src/
|
|
76
|
+
├── commands/ # parses user actions
|
|
77
|
+
├── sessions/ # owns session state
|
|
78
|
+
└── transport/ # sends API requests
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
- Show component interaction, control flow, or data flow with Mermaid:
|
|
82
|
+
|
|
83
|
+
```mermaid
|
|
84
|
+
sequenceDiagram
|
|
85
|
+
participant User
|
|
86
|
+
participant UI
|
|
87
|
+
participant Daemon
|
|
88
|
+
User->>UI: choose command
|
|
89
|
+
UI->>Daemon: send expanded prompt
|
|
90
|
+
Daemon-->>UI: stream result
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
- Use `diff` when the point is what changes and the surrounding shape already exists. Match the diff shape to the topic.
|
|
94
|
+
|
|
95
|
+
For a component change:
|
|
96
|
+
|
|
97
|
+
```diff
|
|
98
|
+
<SessionPage>
|
|
99
|
+
useSessionEvents()
|
|
100
|
+
<SessionToolbar>
|
|
101
|
+
+ <RunSkillButton />
|
|
102
|
+
<SessionTimeline>
|
|
103
|
+
+ <SkillResultCard />
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
For a file-layout change:
|
|
107
|
+
|
|
108
|
+
```diff
|
|
109
|
+
src/
|
|
110
|
+
├── commands/
|
|
111
|
+
+│ └── show-me.ts # expands the slash command
|
|
112
|
+
├── sessions/
|
|
113
|
+
-└── transport.ts
|
|
114
|
+
+└── transport/
|
|
115
|
+
+ ├── client.ts
|
|
116
|
+
+ └── stream.ts
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
For a call-tree or call-stack change:
|
|
120
|
+
|
|
121
|
+
```diff
|
|
122
|
+
submitForm
|
|
123
|
+
createSession
|
|
124
|
+
persistPrompt
|
|
125
|
+
+ expandSkillMention
|
|
126
|
+
launchAgent
|
|
127
|
+
- navigateToSession
|
|
128
|
+
+ navigateToSession
|
|
129
|
+
+ subscribeToEvents
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
For a state or control-flow change:
|
|
133
|
+
|
|
134
|
+
```diff
|
|
135
|
+
on(save)
|
|
136
|
+
- write content
|
|
137
|
+
+ if content is unchanged
|
|
138
|
+
+ return cached result
|
|
139
|
+
+ write new content
|
|
140
|
+
+ invalidate cache
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
- Show the whole block when most of it is new, when omitted context would hide ownership or order, or when the user needs a copyable target shape:
|
|
144
|
+
|
|
145
|
+
```ts
|
|
146
|
+
function expandSkill(command: string): string {
|
|
147
|
+
const skillName = command.slice(1);
|
|
148
|
+
return `use the ${skillName} skill`;
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
#### Guidance
|
|
153
|
+
|
|
154
|
+
Place each visual next to the short text it supports. Keep only the calls, files, props, states, and boundaries needed to answer the user's current question or the options to resolve the current discussion point.
|
|
155
|
+
|
|
156
|
+
You may use one of these, you may use several, it is unlikely you will use all of them. Use your judgement and don't overwhelm the user.
|
|
157
|
+
|
|
158
|
+
### Evidence
|
|
159
|
+
|
|
160
|
+
Concrete evidence that the change works. Show a before and after.
|
|
161
|
+
|
|
162
|
+
Screenshots are S-tier - when the environment is set up for it and the change is visual.
|
|
163
|
+
|
|
164
|
+
Execution-based evidence is A-tier. Test results, console output. Show the exact test that now fails and passes, using pseudocode.
|
|
165
|
+
|
|
166
|
+
### Merge Danger
|
|
167
|
+
|
|
168
|
+
Describe whether it's a one-way or two-way door. You can walk back through two-way doors, but not one-way doors. A PR that is cheap to roll back is lower risk. Changes that involve destructive actions or hard-to-reverse decisions are one-way doors.
|
|
169
|
+
|
|
170
|
+
The blast radius is the potential impact or scope of the changes introduced by this PR. Consider all possibilities. Examples are layout shift, breakages for consumers, mobile responsiveness, etc.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: research
|
|
3
|
+
description: Investigate a question against high-trust primary sources and capture the findings as a Markdown file in the repo. Use when the user wants a topic researched, docs or API facts gathered, or reading legwork delegated to a background agent.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Spin up a **background agent** to do the research, so you keep working while it reads.
|
|
7
|
+
|
|
8
|
+
Its job:
|
|
9
|
+
|
|
10
|
+
1. Investigate the question against **primary sources** (official docs, source code, specs, first-party APIs), not a secondary write-up of them. Follow every claim back to the source that owns it.
|
|
11
|
+
2. Write the findings to a single Markdown file, citing each claim's source.
|
|
12
|
+
3. Save it where the repo already keeps such notes; match the existing convention, and if there is none, put it somewhere sensible and say where.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: retro
|
|
3
|
+
description: "Conduct a retrospective on a coding session."
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The user has asked for a **retrospective**. You are suggesting improvements to the coding agent's **environment** to improve future runs.
|
|
8
|
+
|
|
9
|
+
## Steps
|
|
10
|
+
|
|
11
|
+
1. Call the Skill tool with `writing-for-agents` for the writing style guide.
|
|
12
|
+
|
|
13
|
+
2. Read the primary sources for the session the user specifies. This may mean searching through session logs on this machine. If the user doesn't specify a session, default to the current one.
|
|
14
|
+
|
|
15
|
+
3. Look for candidates for improvement in these categories.
|
|
16
|
+
|
|
17
|
+
- **Navigation**: how easy was it for the agent to find the right files? Are there hidden dependencies between files? Would a **navigation pointer** make it easier? _Use when_ the session took a long time to find a piece of information.
|
|
18
|
+
- **Automated checks**: are there automated checks that could catch errors the agent made? Linting, typing, tests, filesystem linters? Read the repo's own check command first (its `package.json`/build-tool `lint`/`check` scripts, its CI workflow), so a check that already exists but sits unwired or silently broken is the finding, not a reinvention. A repo with no **guardrail** (no pre-commit hook and no CI job running its lint/typecheck/test command) is itself a finding: an un-linted repo is a standing missed opportunity, not a neutral default. _Use when_ the agent made a mistake an automated check could have caught, or the repo has no guardrail at all.
|
|
19
|
+
- **Coding standards**: should the **reviewer agent** be given a new rule to enforce? Should an existing rule be removed or clarified? Classify the violation first: a **mechanical** one (a fixed syntactic pattern, a banned API, an import shape, a file-location rule) gets a deterministic check, full stop: a custom rule in the repo's own linter, a new pre-commit hook, or a new CI job, whichever the repo's language and existing guardrail make cheapest. Default to building the check over writing the rule. Reserve `CODING_STANDARDS.md` for genuine **judgement calls** (cross-file consistency, "matches the surrounding style," anything no guardrail could ever substitute for). _Use when_ the reviewer agent failed to catch a mistake.
|
|
20
|
+
- **Global AGENTS.md**: are there any steering instructions that should be moved to coding standards (or automated checks) instead? _Use when_ the AGENTS.md file is particularly large - in the repo OR the user's global scope.
|
|
21
|
+
- **Tool economy**: did the agent make expensive tool calls that could be streamlined? Is there any custom tooling (CLI's, MCP's) that is particularly token-inefficient? _Use when_ the agent made an expensive tool call.
|
|
22
|
+
- **No-ops**: look for instructions in steering files that don't modify the agent's behavior. _Use when_ the steering files are large and unwieldy.
|
|
23
|
+
- **Information access**: look for opportunities to increase the agent's access to information. Teeing dev server logs, readonly access to third-party services. _Use when_ a crucial piece of information was not available to the agent.
|
|
24
|
+
|
|
25
|
+
4. Present these candidates to the user, in order of severity.
|
|
26
|
+
|
|
27
|
+
## Reference
|
|
28
|
+
|
|
29
|
+
### Implementation vs Review
|
|
30
|
+
|
|
31
|
+
Remember that all work goes through two stages: implementation and review. The implementation agent has the most **context pressure**. They are responsible for exploration, writing code, and debugging failures.
|
|
32
|
+
|
|
33
|
+
The review agent has the least context pressure - it receives a diff, so no exploration needed. It often does not need to write code or debug.
|
|
34
|
+
|
|
35
|
+
This means that the review agent should be responsible for imposing coding standards, not the implementation agent.
|
|
36
|
+
|
|
37
|
+
### Files
|
|
38
|
+
|
|
39
|
+
You have access to several files in the repo:
|
|
40
|
+
|
|
41
|
+
- `CLAUDE.md`/`AGENTS.md`: these files are pushed to the context window of any agent working in this repo. They should be used incredibly sparingly, usually only for **navigation pointers** to other files.
|
|
42
|
+
- `CODING_STANDARDS.md`: this file is read during review, not implementation. Add **navigation pointers** to docs folders if the standards file gets more than 1,000 lines long.
|
|
43
|
+
- Docs: use docs as references files, pointed to by other files. Look for existing docs before writing new ones.
|
|
44
|
+
- Skills: use skills for docs (since their description goes into the agent's context window), or for user-invoked commands. Follow the advice in the `writing-for-agents` skill.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: review
|
|
3
|
+
description: "Single entry point for reviewing a change: pins the diff once, runs the right review lenses in parallel subagents, dedupes and returns one verdict. Use when asked to review a branch, PR, commit range or work-in-progress."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
One command for "review this". It picks the lenses, pins the diff once, fans
|
|
7
|
+
out, then merges everything into a single report with one verdict.
|
|
8
|
+
|
|
9
|
+
## 1. Pin the diff
|
|
10
|
+
|
|
11
|
+
Resolve the fixed point the user gave (commit, branch, tag, `HEAD~N`; ask when
|
|
12
|
+
missing) and capture it once: `git diff <fixed-point>...HEAD` plus
|
|
13
|
+
`git log <fixed-point>..HEAD --oneline`. Fail fast here on a bad ref or an
|
|
14
|
+
empty diff — never inside the subagents.
|
|
15
|
+
|
|
16
|
+
## 2. Pick the lenses
|
|
17
|
+
|
|
18
|
+
Always: `code-review` (its Standards and Spec axes; Standards applies
|
|
19
|
+
`ponytail-review`, never ad-hoc smells) and `persona-review` (does the change
|
|
20
|
+
serve its real audience). Add `adversarial-tests` when logic, handlers or
|
|
21
|
+
endpoints changed; add the `security-reviewer` subagent when auth, secrets,
|
|
22
|
+
tenancy, user data or external calls are touched.
|
|
23
|
+
|
|
24
|
+
## 3. Fan out
|
|
25
|
+
|
|
26
|
+
One subagent per lens, all in parallel (see `parallel-work` for the pattern;
|
|
27
|
+
skip the fan-out and run inline when the diff is a few lines). Every brief is
|
|
28
|
+
self-contained: the diff command, the lens skill to apply, and the evidence
|
|
29
|
+
rule from `ground-truth` — every finding cites `file:line`, or it is not a
|
|
30
|
+
finding. When the change implements a plan with a ladder table, brief
|
|
31
|
+
`code-review` to verify the table against the diff.
|
|
32
|
+
|
|
33
|
+
## 4. Merge
|
|
34
|
+
|
|
35
|
+
Dedupe across lenses (same location and issue keep the strongest wording),
|
|
36
|
+
rank by severity, and end with exactly one verdict: ship, fix-then-ship (list
|
|
37
|
+
the blockers), or rework. One report, no per-lens sections.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rules-upkeep
|
|
3
|
+
description: "Keep AGENTS.md, skills and subagents in sync with decisions made in a session, and in valid format. Use at the end of a coding task when a decision, correction or convention came up, and whenever creating or editing agent instructions."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Rules upkeep
|
|
7
|
+
|
|
8
|
+
The AI setup (`AGENTS.md`, `.agents/skills`, `.agents/agents`) is code: it drifts unless you maintain it. Future sessions only know what is written there.
|
|
9
|
+
|
|
10
|
+
## When to run
|
|
11
|
+
|
|
12
|
+
At the end of any coding task, and when one of these happened:
|
|
13
|
+
|
|
14
|
+
- A design choice was settled or clarified: where a boundary sits, which pattern wins, which exception is allowed.
|
|
15
|
+
- A review showed that the current rules **allow** a bad pattern.
|
|
16
|
+
- You were corrected twice on the same thing.
|
|
17
|
+
- A new convention was adopted (naming, testing, wiring).
|
|
18
|
+
- A shortcut with a stated limit was left in code and will recur.
|
|
19
|
+
|
|
20
|
+
## What to do
|
|
21
|
+
|
|
22
|
+
1. Locate the gap: which file says nothing, is out of date, or disagrees with the decision?
|
|
23
|
+
2. Make the **smallest additive edit** in the same turn, in the natural home. Do not ask first. Do not create a new file when an existing one fits.
|
|
24
|
+
3. Change every file the decision touches, and no more. Link to the canonical text instead of copying it.
|
|
25
|
+
4. Removing a rule needs the user's confirmation.
|
|
26
|
+
5. Finish with one line: `Rules: none` or `Rules: <file> — <what changed>`.
|
|
27
|
+
|
|
28
|
+
## Where things go
|
|
29
|
+
|
|
30
|
+
| Content | Home |
|
|
31
|
+
|---|---|
|
|
32
|
+
| Non-negotiables for the whole repo, commands, map | root `AGENTS.md`, short (it is always loaded) |
|
|
33
|
+
| Rules for one folder | `AGENTS.md` in that folder (read when working there) |
|
|
34
|
+
| A repeatable workflow with steps | a skill |
|
|
35
|
+
| A persona with a narrow job and fresh context | a subagent |
|
|
36
|
+
|
|
37
|
+
Do not write down what the code already shows (file lists, signatures). Write only what a reader cannot get from the code: the why, the limits, the traps.
|
|
38
|
+
|
|
39
|
+
## Formats that fail silently
|
|
40
|
+
|
|
41
|
+
| Artifact | Required | Otherwise |
|
|
42
|
+
|---|---|---|
|
|
43
|
+
| Skill | folder `<name>/SKILL.md`, `name` equals the folder | may never be loaded |
|
|
44
|
+
| Subagent | file `<name>.md`, `description` on a single line | a folded or block description can be shown as `>` and the agent cannot decide when to be used |
|
|
45
|
+
| Any file | LF line endings | a trailing `\r` breaks YAML values |
|
|
46
|
+
| Subagent `model` | omit it, or `inherit` | an unknown model id can fall back silently; list the models the tool accepts before pinning one |
|
|
47
|
+
|
|
48
|
+
Run `zedkit-ai validate` (package `@zedtech/zedkit-ai`, or the repo's equivalent) after editing. It checks these.
|
|
49
|
+
|
|
50
|
+
## Writing for agents
|
|
51
|
+
|
|
52
|
+
- Imperative, concrete, short. One rule per bullet. Examples beat adjectives.
|
|
53
|
+
- Put the trigger in the skill `description`: "Use when ...". That line decides whether it is ever loaded.
|
|
54
|
+
- Large reference material goes in a sibling file, linked from the skill, not in `SKILL.md`.
|
|
55
|
+
- Never put secrets, customer names or internal URLs in instructions.
|