jonah-fleet 1.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/CHANGELOG.md +17 -0
- package/README.md +133 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +454 -0
- package/package.json +47 -0
- package/schema.json +49 -0
- package/templates/docs/AGENTS.template.md +54 -0
- package/templates/prompts/ORCHESTRATION.md +97 -0
- package/templates/prompts/_prompt-template.md +43 -0
- package/templates/prompts/autowork.md +125 -0
- package/templates/prompts/dependency-update-security-check.md +44 -0
- package/templates/prompts/issues-housekeeping.md +55 -0
- package/templates/prompts/optimizer.md +72 -0
- package/templates/prompts/peer-review.md +112 -0
- package/templates/prompts/product-planning.md +67 -0
- package/templates/skills/code-review/SKILL.md +87 -0
- package/templates/skills/code-review/agents/openai.yaml +3 -0
- package/templates/skills/codebase-design/DEEPENING.md +37 -0
- package/templates/skills/codebase-design/DESIGN-IT-TWICE.md +44 -0
- package/templates/skills/codebase-design/SKILL.md +114 -0
- package/templates/skills/codebase-design/agents/openai.yaml +3 -0
- package/templates/skills/diagnosing-bugs/SKILL.md +138 -0
- package/templates/skills/diagnosing-bugs/agents/openai.yaml +3 -0
- package/templates/skills/diagnosing-bugs/scripts/hitl-loop.template.sh +44 -0
- package/templates/skills/domain-modeling/ADR-FORMAT.md +47 -0
- package/templates/skills/domain-modeling/CONTEXT-FORMAT.md +60 -0
- package/templates/skills/domain-modeling/SKILL.md +74 -0
- package/templates/skills/domain-modeling/agents/openai.yaml +3 -0
- package/templates/skills/resolving-merge-conflicts/SKILL.md +14 -0
- package/templates/skills/resolving-merge-conflicts/agents/openai.yaml +3 -0
- package/templates/skills/tdd/SKILL.md +38 -0
- package/templates/skills/tdd/agents/openai.yaml +3 -0
- package/templates/skills/tdd/mocking.md +59 -0
- package/templates/skills/tdd/tests.md +77 -0
- package/templates/skills/to-spec/SKILL.md +75 -0
- package/templates/skills/to-spec/agents/openai.yaml +5 -0
- package/templates/skills/to-tickets/SKILL.md +105 -0
- package/templates/skills/to-tickets/agents/openai.yaml +5 -0
- package/templates/skills/triage/AGENT-BRIEF.md +207 -0
- package/templates/skills/triage/OUT-OF-SCOPE.md +105 -0
- package/templates/skills/triage/SKILL.md +112 -0
- package/templates/skills/triage/agents/openai.yaml +5 -0
- package/templates/skills/writing-for-agents/SKILL-MECHANICS.md +22 -0
- package/templates/skills/writing-for-agents/SKILL.md +81 -0
- package/templates/skills/writing-for-agents/agents/openai.yaml +3 -0
- package/templates/workflows/autowork-cron.yml +154 -0
- package/templates/workflows/dependency-check-cron.yml +85 -0
- package/templates/workflows/issues-housekeeping-cron.yml +85 -0
- package/templates/workflows/prompt-optimizer-cron.yml +85 -0
- package/templates/workflows/sync-fleet.yml +63 -0
- package/templates/workflows/trigger-autowork-on-bug.yml +101 -0
- package/templates/workflows/trigger-autowork-on-merge.yml +130 -0
- package/templates/workflows/trigger-review-routine.yml +141 -0
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
# Writing Agent Briefs
|
|
2
|
+
|
|
3
|
+
An agent brief is a structured comment posted on a GitHub issue or PR when it moves to `ready-for-agent`. It is the authoritative specification that an AFK agent will work from. The original body and discussion are context: the agent brief is the contract.
|
|
4
|
+
|
|
5
|
+
The brief states **what the agent should do**, which stretches to both surfaces: for an issue, that's building the change from nothing; for a PR, it's what's left to do *to the existing diff*: finish it, close gaps, address review points. Same principles either way; the PR example below shows the difference.
|
|
6
|
+
|
|
7
|
+
## Principles
|
|
8
|
+
|
|
9
|
+
### Durability over precision
|
|
10
|
+
|
|
11
|
+
The issue may sit in `ready-for-agent` for days or weeks. The codebase will change in the meantime. Write the brief so it stays useful even as files are renamed, moved, or refactored.
|
|
12
|
+
|
|
13
|
+
- **Do** describe interfaces, types, and behavioral contracts
|
|
14
|
+
- **Do** name specific types, function signatures, or config shapes that the agent should look for or modify
|
|
15
|
+
- **Don't** reference file paths: they go stale
|
|
16
|
+
- **Don't** reference line numbers
|
|
17
|
+
- **Don't** assume the current implementation structure will remain the same
|
|
18
|
+
|
|
19
|
+
### Behavioral, not procedural
|
|
20
|
+
|
|
21
|
+
Describe **what** the system should do, not **how** to implement it. The agent will explore the codebase fresh and make its own implementation decisions.
|
|
22
|
+
|
|
23
|
+
- **Good:** "The `SkillConfig` type should accept an optional `schedule` field of type `CronExpression`"
|
|
24
|
+
- **Bad:** "Open src/types/skill.ts and add a schedule field on line 42"
|
|
25
|
+
- **Good:** "When a user runs `/triage` with no arguments, they should see a summary of issues needing attention"
|
|
26
|
+
- **Bad:** "Add a switch statement in the main handler function"
|
|
27
|
+
|
|
28
|
+
### Complete acceptance criteria
|
|
29
|
+
|
|
30
|
+
The agent needs to know when it's done. Every agent brief must have concrete, testable acceptance criteria. Each criterion should be independently verifiable.
|
|
31
|
+
|
|
32
|
+
- **Good:** "Running `gh issue list --label needs-triage` returns issues that have been through initial classification"
|
|
33
|
+
- **Bad:** "Triage should work correctly"
|
|
34
|
+
|
|
35
|
+
### Explicit scope boundaries
|
|
36
|
+
|
|
37
|
+
State what is out of scope. This prevents the agent from gold-plating or making assumptions about adjacent features.
|
|
38
|
+
|
|
39
|
+
## Template
|
|
40
|
+
|
|
41
|
+
```markdown
|
|
42
|
+
## Agent Brief
|
|
43
|
+
|
|
44
|
+
**Category:** bug / enhancement
|
|
45
|
+
**Summary:** one-line description of what needs to happen
|
|
46
|
+
|
|
47
|
+
**Current behavior:**
|
|
48
|
+
Describe what happens now. For bugs, this is the broken behavior.
|
|
49
|
+
For enhancements, this is the status quo the feature builds on.
|
|
50
|
+
|
|
51
|
+
**Desired behavior:**
|
|
52
|
+
Describe what should happen after the agent's work is complete.
|
|
53
|
+
Be specific about edge cases and error conditions.
|
|
54
|
+
|
|
55
|
+
**Key interfaces:**
|
|
56
|
+
- `TypeName`: what needs to change and why
|
|
57
|
+
- `functionName()` return type: what it currently returns vs what it should return
|
|
58
|
+
- Config shape: any new configuration options needed
|
|
59
|
+
|
|
60
|
+
**Acceptance criteria:**
|
|
61
|
+
- [ ] Specific, testable criterion 1
|
|
62
|
+
- [ ] Specific, testable criterion 2
|
|
63
|
+
- [ ] Specific, testable criterion 3
|
|
64
|
+
|
|
65
|
+
**Out of scope:**
|
|
66
|
+
- Thing that should NOT be changed or addressed in this issue
|
|
67
|
+
- Adjacent feature that might seem related but is separate
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Examples
|
|
71
|
+
|
|
72
|
+
### Good agent brief (bug)
|
|
73
|
+
|
|
74
|
+
```markdown
|
|
75
|
+
## Agent Brief
|
|
76
|
+
|
|
77
|
+
**Category:** bug
|
|
78
|
+
**Summary:** Skill description truncation drops mid-word, producing broken output
|
|
79
|
+
|
|
80
|
+
**Current behavior:**
|
|
81
|
+
When a skill description exceeds 1024 characters, it is truncated at exactly
|
|
82
|
+
1024 characters regardless of word boundaries. This produces descriptions
|
|
83
|
+
that end mid-word (e.g. "Use when the user wants to confi").
|
|
84
|
+
|
|
85
|
+
**Desired behavior:**
|
|
86
|
+
Truncation should break at the last word boundary before 1024 characters
|
|
87
|
+
and append "..." to indicate truncation.
|
|
88
|
+
|
|
89
|
+
**Key interfaces:**
|
|
90
|
+
- The `SkillMetadata` type's `description` field: no type change needed,
|
|
91
|
+
but the validation/processing logic that populates it needs to respect
|
|
92
|
+
word boundaries
|
|
93
|
+
- Any function that reads SKILL.md frontmatter and extracts the description
|
|
94
|
+
|
|
95
|
+
**Acceptance criteria:**
|
|
96
|
+
- [ ] Descriptions under 1024 chars are unchanged
|
|
97
|
+
- [ ] Descriptions over 1024 chars are truncated at the last word boundary
|
|
98
|
+
before 1024 chars
|
|
99
|
+
- [ ] Truncated descriptions end with "..."
|
|
100
|
+
- [ ] The total length including "..." does not exceed 1024 chars
|
|
101
|
+
|
|
102
|
+
**Out of scope:**
|
|
103
|
+
- Changing the 1024 char limit itself
|
|
104
|
+
- Multi-line description support
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Good agent brief (enhancement)
|
|
108
|
+
|
|
109
|
+
```markdown
|
|
110
|
+
## Agent Brief
|
|
111
|
+
|
|
112
|
+
**Category:** enhancement
|
|
113
|
+
**Summary:** Add `.out-of-scope/` directory support for tracking rejected feature requests
|
|
114
|
+
|
|
115
|
+
**Current behavior:**
|
|
116
|
+
When a feature request is rejected, the issue is closed with a `wontfix` label
|
|
117
|
+
and a comment. There is no persistent record of the decision or reasoning.
|
|
118
|
+
Future similar requests require the maintainer to recall or search for the
|
|
119
|
+
prior discussion.
|
|
120
|
+
|
|
121
|
+
**Desired behavior:**
|
|
122
|
+
Rejected feature requests should be documented in `.out-of-scope/<concept>.md`
|
|
123
|
+
files that capture the decision, reasoning, and links to all issues that
|
|
124
|
+
requested the feature. When triaging new issues, these files should be
|
|
125
|
+
checked for matches.
|
|
126
|
+
|
|
127
|
+
**Key interfaces:**
|
|
128
|
+
- Markdown file format in `.out-of-scope/`: each file should have a
|
|
129
|
+
`# Concept Name` heading, a `**Decision:**` line, a `**Reason:**` line,
|
|
130
|
+
and a `**Prior requests:**` list with issue links
|
|
131
|
+
- The triage workflow should read all `.out-of-scope/*.md` files early
|
|
132
|
+
and match incoming issues against them by concept similarity
|
|
133
|
+
|
|
134
|
+
**Acceptance criteria:**
|
|
135
|
+
- [ ] Closing a feature as wontfix creates/updates a file in `.out-of-scope/`
|
|
136
|
+
- [ ] The file includes the decision, reasoning, and link to the closed issue
|
|
137
|
+
- [ ] If a matching `.out-of-scope/` file already exists, the new issue is
|
|
138
|
+
appended to its "Prior requests" list rather than creating a duplicate
|
|
139
|
+
- [ ] During triage, existing `.out-of-scope/` files are checked and surfaced
|
|
140
|
+
when a new issue matches a prior rejection
|
|
141
|
+
|
|
142
|
+
**Out of scope:**
|
|
143
|
+
- Automated matching (human confirms the match)
|
|
144
|
+
- Reopening previously rejected features
|
|
145
|
+
- Bug reports (only enhancement rejections go to `.out-of-scope/`)
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Good agent brief (PR)
|
|
149
|
+
|
|
150
|
+
For a PR, "Current behavior" describes the state of the diff, and the brief asks the agent to finish or fix it rather than build from scratch.
|
|
151
|
+
|
|
152
|
+
```markdown
|
|
153
|
+
## Agent Brief
|
|
154
|
+
|
|
155
|
+
**Category:** enhancement
|
|
156
|
+
**Summary:** Finish the contributor's `--json` output flag for `triage list`
|
|
157
|
+
|
|
158
|
+
**Current behavior:**
|
|
159
|
+
The PR adds a `--json` flag that serializes the issue list to JSON. The happy
|
|
160
|
+
path works and the diff matches the project's command structure. Two gaps
|
|
161
|
+
remain: errors are still printed as human text (not JSON), and the new flag has
|
|
162
|
+
no test coverage.
|
|
163
|
+
|
|
164
|
+
**Desired behavior:**
|
|
165
|
+
With `--json`, all output (including errors) is well-formed JSON on stdout,
|
|
166
|
+
and the command's exit codes are unchanged. The existing human-readable output
|
|
167
|
+
is untouched when the flag is absent.
|
|
168
|
+
|
|
169
|
+
**Key interfaces:**
|
|
170
|
+
- The command's error path should emit `{ "error": string }` under `--json`
|
|
171
|
+
instead of the plain-text error
|
|
172
|
+
- Reuse the existing serializer the PR already added; don't introduce a second
|
|
173
|
+
|
|
174
|
+
**Acceptance criteria:**
|
|
175
|
+
- [ ] `triage list --json` emits valid JSON for both success and error cases
|
|
176
|
+
- [ ] Exit codes match the non-JSON command
|
|
177
|
+
- [ ] A test covers the `--json` success output and one error case
|
|
178
|
+
- [ ] Default (non-JSON) output is byte-for-byte unchanged
|
|
179
|
+
|
|
180
|
+
**Out of scope:**
|
|
181
|
+
- Adding `--json` to any other command
|
|
182
|
+
- Changing the JSON shape of the success payload the PR already defined
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Bad agent brief
|
|
186
|
+
|
|
187
|
+
```markdown
|
|
188
|
+
## Agent Brief
|
|
189
|
+
|
|
190
|
+
**Summary:** Fix the triage bug
|
|
191
|
+
|
|
192
|
+
**What to do:**
|
|
193
|
+
The triage thing is broken. Look at the main file and fix it.
|
|
194
|
+
The function around line 150 has the issue.
|
|
195
|
+
|
|
196
|
+
**Files to change:**
|
|
197
|
+
- src/triage/handler.ts (line 150)
|
|
198
|
+
- src/types.ts (line 42)
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
This is bad because:
|
|
202
|
+
- No category
|
|
203
|
+
- Vague description ("the triage thing is broken")
|
|
204
|
+
- References file paths and line numbers that will go stale
|
|
205
|
+
- No acceptance criteria
|
|
206
|
+
- No scope boundaries
|
|
207
|
+
- No description of current vs desired behavior
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# Out-of-Scope Knowledge Base
|
|
2
|
+
|
|
3
|
+
The `.out-of-scope/` directory in a repo stores persistent records of rejected feature requests. It serves two purposes:
|
|
4
|
+
|
|
5
|
+
1. **Institutional memory**: why a feature was rejected, so the reasoning isn't lost when the issue is closed
|
|
6
|
+
2. **Deduplication**: when a new issue comes in that matches a prior rejection, the skill can surface the previous decision instead of re-litigating it
|
|
7
|
+
|
|
8
|
+
## Directory structure
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
.out-of-scope/
|
|
12
|
+
├── dark-mode.md
|
|
13
|
+
├── plugin-system.md
|
|
14
|
+
└── graphql-api.md
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
One file per **concept**, not per issue. Multiple issues requesting the same thing are grouped under one file.
|
|
18
|
+
|
|
19
|
+
## File format
|
|
20
|
+
|
|
21
|
+
The file should be written in a relaxed, readable style, more like a short design document than a database entry. Use paragraphs, code samples, and examples to make the reasoning clear and useful to someone encountering it for the first time.
|
|
22
|
+
|
|
23
|
+
```markdown
|
|
24
|
+
# Dark Mode
|
|
25
|
+
|
|
26
|
+
This project does not support dark mode or user-facing theming.
|
|
27
|
+
|
|
28
|
+
## Why this is out of scope
|
|
29
|
+
|
|
30
|
+
The rendering pipeline assumes a single color palette defined in
|
|
31
|
+
`ThemeConfig`. Supporting multiple themes would require:
|
|
32
|
+
|
|
33
|
+
- A theme context provider wrapping the entire component tree
|
|
34
|
+
- Per-component theme-aware style resolution
|
|
35
|
+
- A persistence layer for user theme preferences
|
|
36
|
+
|
|
37
|
+
This is a significant architectural change that doesn't align with the
|
|
38
|
+
project's focus on content authoring. Theming is a concern for downstream
|
|
39
|
+
consumers who embed or redistribute the output.
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
// The current ThemeConfig interface is not designed for runtime switching:
|
|
43
|
+
interface ThemeConfig {
|
|
44
|
+
colors: ColorPalette; // single palette, resolved at build time
|
|
45
|
+
fonts: FontStack;
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Prior requests
|
|
50
|
+
|
|
51
|
+
- #42: "Add dark mode support"
|
|
52
|
+
- #87: "Night theme for accessibility"
|
|
53
|
+
- #134: "Dark theme option"
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Naming the file
|
|
57
|
+
|
|
58
|
+
Use a short, descriptive kebab-case name for the concept: `dark-mode.md`, `plugin-system.md`, `graphql-api.md`. The name should be recognizable enough that someone browsing the directory understands what was rejected without opening the file.
|
|
59
|
+
|
|
60
|
+
### Writing the reason
|
|
61
|
+
|
|
62
|
+
The reason should be substantive: not "we don't want this" but why. Good reasons reference:
|
|
63
|
+
|
|
64
|
+
- Project scope or philosophy ("This project focuses on X; theming is a downstream concern")
|
|
65
|
+
- Technical constraints ("Supporting this would require Y, which conflicts with our Z architecture")
|
|
66
|
+
- Strategic decisions ("We chose to use A instead of B because...")
|
|
67
|
+
|
|
68
|
+
The reason should be durable. Avoid referencing temporary circumstances ("we're too busy right now"); those aren't real rejections, they're deferrals.
|
|
69
|
+
|
|
70
|
+
## When to check `.out-of-scope/`
|
|
71
|
+
|
|
72
|
+
During triage (Step 1: Gather context), read all files in `.out-of-scope/`. When evaluating a new issue:
|
|
73
|
+
|
|
74
|
+
- Check if the request matches an existing out-of-scope concept
|
|
75
|
+
- Matching is by concept similarity, not keyword: "night theme" matches `dark-mode.md`
|
|
76
|
+
- If there's a match, surface it to the maintainer: "This is similar to `.out-of-scope/dark-mode.md`. We rejected this before because [reason]. Do you still feel the same way?"
|
|
77
|
+
|
|
78
|
+
The maintainer may:
|
|
79
|
+
|
|
80
|
+
- **Confirm**: the new issue gets added to the existing file's "Prior requests" list, then closed
|
|
81
|
+
- **Reconsider**: the out-of-scope file gets deleted or updated, and the issue proceeds through normal triage
|
|
82
|
+
- **Disagree**: the issues are related but distinct, proceed with normal triage
|
|
83
|
+
|
|
84
|
+
## When to write to `.out-of-scope/`
|
|
85
|
+
|
|
86
|
+
Only when an **enhancement** (not a bug) is *rejected* as `wontfix`. This applies to enhancement PRs exactly as it does to issues: a rejected PR is recorded here so the same request doesn't return as fresh code.
|
|
87
|
+
|
|
88
|
+
Do **not** write here when something is closed as `wontfix` because it's **already implemented**. That's a built feature, not a rejected one; recording it would poison the dedup checks with false rejections. Instead, the closing comment points to where the feature already lives.
|
|
89
|
+
|
|
90
|
+
The flow:
|
|
91
|
+
|
|
92
|
+
1. Maintainer decides a feature request is out of scope
|
|
93
|
+
2. Check if a matching `.out-of-scope/` file already exists
|
|
94
|
+
3. If yes: append the new issue to the "Prior requests" list
|
|
95
|
+
4. If no: create a new file with the concept name, decision, reason, and first prior request
|
|
96
|
+
5. Post a comment on the issue explaining the decision and mentioning the `.out-of-scope/` file
|
|
97
|
+
6. Close the issue with the `wontfix` label
|
|
98
|
+
|
|
99
|
+
## Updating or removing out-of-scope files
|
|
100
|
+
|
|
101
|
+
If the maintainer changes their mind about a previously rejected concept:
|
|
102
|
+
|
|
103
|
+
- Delete the `.out-of-scope/` file
|
|
104
|
+
- The skill does not need to reopen old issues; they're historical records
|
|
105
|
+
- The new issue that triggered the reconsideration proceeds through normal triage
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: triage
|
|
3
|
+
description: Move issues and external PRs through a state machine of triage roles, categorise, verify, grill if needed, and write agent-ready briefs.
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Triage
|
|
8
|
+
|
|
9
|
+
Move issues on the project issue tracker through a small state machine of triage roles.
|
|
10
|
+
|
|
11
|
+
If this repo treats external pull requests as a request surface (see the issue-tracker config), triage covers them too: **a PR is an issue with attached code**, using the same roles, same states, and same machine, with a few deltas marked "for a PR" below. Resolve a bare `#42` to an issue or PR per the tracker config.
|
|
12
|
+
|
|
13
|
+
Every comment or issue posted to the issue tracker during triage **must** start with this disclaimer:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
> *This was generated by AI during triage.*
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Reference docs
|
|
20
|
+
|
|
21
|
+
- [AGENT-BRIEF.md](AGENT-BRIEF.md): how to write durable agent briefs
|
|
22
|
+
- [OUT-OF-SCOPE.md](OUT-OF-SCOPE.md): how the `.out-of-scope/` knowledge base works
|
|
23
|
+
|
|
24
|
+
## Roles
|
|
25
|
+
|
|
26
|
+
Two **category** roles:
|
|
27
|
+
|
|
28
|
+
- `bug`: something is broken
|
|
29
|
+
- `enhancement`: new feature or improvement
|
|
30
|
+
|
|
31
|
+
Five **state** roles:
|
|
32
|
+
|
|
33
|
+
- `needs-triage`: maintainer needs to evaluate
|
|
34
|
+
- `needs-info`: waiting on reporter for more information
|
|
35
|
+
- `ready-for-agent`: fully specified, ready for an AFK agent
|
|
36
|
+
- `ready-for-human`: needs human implementation
|
|
37
|
+
- `wontfix`: will not be actioned
|
|
38
|
+
|
|
39
|
+
For a PR, the same states read against the attached code: `ready-for-agent` means a brief is attached and an agent should take the next step on the diff; `ready-for-human` means it's ready for a human to merge.
|
|
40
|
+
|
|
41
|
+
Every triaged issue should carry exactly one category role and one state role. If state roles conflict, flag it and ask the maintainer before doing anything else.
|
|
42
|
+
|
|
43
|
+
These are canonical role names. The actual label strings used in the issue tracker may differ. The mapping should have been provided to you. If not, tell the user to run `/setup-matt-pocock-skills`.
|
|
44
|
+
|
|
45
|
+
State transitions: an unlabeled issue normally goes to `needs-triage` first; from there it moves to `needs-info`, `ready-for-agent`, `ready-for-human`, or `wontfix`. `needs-info` returns to `needs-triage` once the reporter replies. The maintainer can override at any time; flag transitions that look unusual and ask before proceeding.
|
|
46
|
+
|
|
47
|
+
## Invocation
|
|
48
|
+
|
|
49
|
+
The maintainer invokes `/triage` and describes what they want in natural language. Interpret the request and act. Examples:
|
|
50
|
+
|
|
51
|
+
- "Show me anything that needs my attention"
|
|
52
|
+
- "Let's look at #42" (issue or PR)
|
|
53
|
+
- "Move #42 to ready-for-agent"
|
|
54
|
+
- "What's ready for agents to pick up?"
|
|
55
|
+
|
|
56
|
+
## Show what needs attention
|
|
57
|
+
|
|
58
|
+
Query the issue tracker and present three buckets, oldest first:
|
|
59
|
+
|
|
60
|
+
1. **Unlabeled**: never triaged.
|
|
61
|
+
2. **`needs-triage`**: evaluation in progress.
|
|
62
|
+
3. **`needs-info` with reporter activity since the last triage notes**: needs re-evaluation.
|
|
63
|
+
|
|
64
|
+
When PRs are in scope, include external PRs in these buckets and tag each line `[PR]` or `[issue]`. Discovery surfaces only *external* PRs (the tracker config defines who counts as external), so a collaborator's in-flight PR is not triage work. This filter is discovery-only; an explicitly named PR is always triaged regardless of author.
|
|
65
|
+
|
|
66
|
+
Show counts and a one-line summary per item. Let the maintainer pick.
|
|
67
|
+
|
|
68
|
+
## Triage a specific issue or PR
|
|
69
|
+
|
|
70
|
+
1. **Gather context.** Read the full issue or PR (body, comments, labels, author, dates; for a PR, the diff too). Parse any prior triage notes so you don't re-ask resolved questions. Explore the codebase using the project's domain glossary, respecting ADRs in the area. Run two checks against the codebase: (a) **redundancy**: search for an existing implementation of the requested behavior by domain concept (not just the request's wording), and report where you looked. If found, it's an already-implemented `wontfix` (step 5). (b) **prior rejection**: read `.out-of-scope/*.md` and surface any that resembles this request.
|
|
71
|
+
|
|
72
|
+
2. **Recommend.** Tell the maintainer your category and state recommendation with reasoning, plus a brief codebase summary relevant to the request (including whether it's already implemented). Wait for direction.
|
|
73
|
+
|
|
74
|
+
3. **Verify the claim.** Before any grilling, check that the claim holds up. For a bug, reproduce it from the reporter's steps. For a PR, confirm the diff does what it claims: check it out, run the relevant tests or commands. Report what happened: confirmed (with code path), failed, or insufficient detail (a strong `needs-info` signal). A confirmed verification makes a much stronger agent brief.
|
|
75
|
+
|
|
76
|
+
4. **Grill (if needed).** If the request needs fleshing out, call the Skill tool twice, for "grilling" and "domain-modeling", and grill it into shape a round of questions at a time, sharpening domain terms and updating `CONTEXT.md`/ADRs inline as decisions land.
|
|
77
|
+
|
|
78
|
+
5. **Apply the outcome:**
|
|
79
|
+
- `ready-for-agent`: post an agent brief comment ([AGENT-BRIEF.md](AGENT-BRIEF.md)).
|
|
80
|
+
- `ready-for-human`: same structure as an agent brief, but note why it can't be delegated (judgment calls, external access, design decisions, manual testing).
|
|
81
|
+
- `needs-info`: post triage notes (template below).
|
|
82
|
+
- For `wontfix`, close the issue, with the comment depending on *why*:
|
|
83
|
+
- **Already implemented**: the change already exists in the codebase. Point to where it lives; do **not** write to `.out-of-scope/` (that KB is for *rejected* requests, not built ones).
|
|
84
|
+
- **Rejected (bug)**: give a polite explanation, then close.
|
|
85
|
+
- **Rejected (enhancement)**: write to `.out-of-scope/`, link to it from a comment, then close ([OUT-OF-SCOPE.md](OUT-OF-SCOPE.md)).
|
|
86
|
+
- `needs-triage`: apply the role. Optional comment if there's partial progress.
|
|
87
|
+
|
|
88
|
+
## Quick state override
|
|
89
|
+
|
|
90
|
+
If the maintainer says "move #42 to ready-for-agent", trust them and apply the role directly. Confirm what you're about to do (role changes, comment, close), then act. Skip grilling. If moving to `ready-for-agent` without a grilling session, ask whether they want to write an agent brief.
|
|
91
|
+
|
|
92
|
+
## Needs-info template
|
|
93
|
+
|
|
94
|
+
```markdown
|
|
95
|
+
## Triage Notes
|
|
96
|
+
|
|
97
|
+
**What we've established so far:**
|
|
98
|
+
|
|
99
|
+
- point 1
|
|
100
|
+
- point 2
|
|
101
|
+
|
|
102
|
+
**What we still need from you (@reporter):**
|
|
103
|
+
|
|
104
|
+
- question 1
|
|
105
|
+
- question 2
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Capture everything resolved during grilling under "established so far" so the work isn't lost. Questions must be specific and actionable, not "please provide more info".
|
|
109
|
+
|
|
110
|
+
## Resuming a previous session
|
|
111
|
+
|
|
112
|
+
If prior triage notes exist on the issue or PR, read them, check whether the reporter has answered any outstanding questions, and present an updated picture before continuing. Don't re-ask resolved questions.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Skill mechanics
|
|
2
|
+
|
|
3
|
+
The skill-specific branch of [`writing-for-agents`](SKILL.md): what changes when the document is a skill (frontmatter, the invocation choice, and router skills). Everything else about writing it is the universal reference in `SKILL.md`.
|
|
4
|
+
|
|
5
|
+
## Invocation
|
|
6
|
+
|
|
7
|
+
Two choices, trading the two loads:
|
|
8
|
+
|
|
9
|
+
- A **model-invoked** skill keeps a `description`, so the agent can fire it autonomously, and other skills can reach it. You can still type its name: model-invocation always _includes_ user reach; a description only ever adds agent discovery, never removes the human's. The description is the skill's top-level context pointer, forced to stay loaded at all times: permanent context load in exchange for discoverability. A model-invoked skill whose content is all reference is also one home for shared reference: another skill can invoke it, so reference needed by several skills lives in one place. Mechanics: omit `disable-model-invocation`, and write a model-facing description carrying the trigger branches (the pointer-writing rules in `SKILL.md` apply in full).
|
|
10
|
+
- A **user-invoked** skill strips the description from the agent's reach: only the human typing its name can invoke it, and no other skill can. Zero context load, but it spends cognitive load: you are the index that must remember it exists. Mechanics: set `disable-model-invocation: true`; the `description` becomes human-facing: a one-line summary, trigger lists stripped.
|
|
11
|
+
|
|
12
|
+
Pick model-invocation only when the agent must reach the skill on its own, or another skill must. If it only ever fires by hand, make it user-invoked and pay no context load.
|
|
13
|
+
|
|
14
|
+
Shared reference that two user-invoked skills both need can live in neither: with no descriptions, neither can fire the other. Push it to a plain file outside the skill system: external reference any skill can point at.
|
|
15
|
+
|
|
16
|
+
## Splitting by invocation
|
|
17
|
+
|
|
18
|
+
The invocation cut of splitting (the sequence cut lives in `SKILL.md`): split off a model-invoked skill when you have a distinct leading word that should trigger it on its own (a trigger word you actually use in your prompts), or another skill must reach it. You pay context load for the new always-loaded description, so that independent reach has to be worth it.
|
|
19
|
+
|
|
20
|
+
## Router skills
|
|
21
|
+
|
|
22
|
+
When user-invoked skills multiply past what you can remember, that piled-up cognitive load is cured by a **router skill**: one user-invoked skill that names the others and when to reach for each, so the human has one skill to remember instead of many. It can only hint, never fire them: user-invoked skills have no description, so nothing but the human can reach them.
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: writing-for-agents
|
|
3
|
+
description: Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Reference for writing any document an agent consumes: a skill, an `AGENTS.md` / `CLAUDE.md`, a doc reached by a pointer. The packaging differs; the writing does not: the same levers make each one predictable, since the agent takes the same _process_ every run rather than producing the same output.
|
|
7
|
+
|
|
8
|
+
When the document you're writing is a skill, read [`SKILL-MECHANICS.md`](SKILL-MECHANICS.md) for frontmatter, invocation choice, and router skills.
|
|
9
|
+
|
|
10
|
+
## Context pointers
|
|
11
|
+
|
|
12
|
+
A **context pointer** is a reference held in the agent's context that names some out-of-context material and encodes the condition for reaching it. A skill's description is one; a line in `AGENTS.md` naming a doc is the same object. The pointer's _wording_, not its target, decides when the agent reaches the material, and how reliably. A must-have target behind a weakly worded pointer is a variance bug: sharpen the wording first, and inline the material only if sharpening fails.
|
|
13
|
+
|
|
14
|
+
A pointer does two jobs: state what the material is, and list the **branches** that should trigger reaching it (a branch is a distinct case the document handles, so different runs take different paths through it). Every word of an always-loaded pointer costs on every turn, so it earns even harder pruning than the body:
|
|
15
|
+
|
|
16
|
+
- **Front-load the leading word**: the pointer is where it does its triggering work.
|
|
17
|
+
- **One trigger per branch.** Synonyms that rename a single branch are one branch written twice; collapse them and keep only genuinely distinct branches.
|
|
18
|
+
- **Cut identity the body already carries.**
|
|
19
|
+
|
|
20
|
+
## The two loads
|
|
21
|
+
|
|
22
|
+
Every document and pointer you add spends one of two budgets:
|
|
23
|
+
|
|
24
|
+
- **Context load** is the cost of always-loaded material on the agent's window: an `AGENTS.md` line, a skill description, anything sitting in context every turn, spending tokens and attention whether or not it fires.
|
|
25
|
+
- **Cognitive load** is the cost on the human: which documents exist and when to reach for each. The human is the index. Not a cost to minimise: it is the price of human agency; spend it where human judgement matters, remove it where it does not.
|
|
26
|
+
|
|
27
|
+
Material reached only through a pointer escapes context load at the price of the pointer's own line; material with no pointer at all rides entirely on cognitive load.
|
|
28
|
+
|
|
29
|
+
## Information hierarchy
|
|
30
|
+
|
|
31
|
+
A document is built from two content types: **steps** (the ordered actions the agent performs) and **reference** (definitions, rules, facts consulted on demand). The two mix freely: all steps (a recipe), all reference (a review's rules, this skill), or both. The core decision is where each piece sits on the **information hierarchy**, a ladder ranked by how immediately the agent needs the material:
|
|
32
|
+
|
|
33
|
+
1. **In-file step** is the primary tier: what the agent does, in order.
|
|
34
|
+
2. **In-file reference** is consulted on demand. Often a legitimately flat peer-set (every rule of a review on one rung), which is a fine arrangement, not a smell.
|
|
35
|
+
3. **Disclosed reference** is pushed out into a separate file, reached by a context pointer, loaded only when the pointer fires. Spans a sibling file in the same folder through fully external reference that lives anywhere and any document can point at.
|
|
36
|
+
|
|
37
|
+
Push too little down and the top bloats; push too much and you hide material the agent actually needs. That tension is the whole decision.
|
|
38
|
+
|
|
39
|
+
**Progressive disclosure** is the move down the ladder (out of the main file and behind a pointer) so the top stays legible. Not primarily a token optimisation: it is how the hierarchy is protected. Branching is the cleanest disclosure test: inline what every branch needs, and push behind a pointer what only some branches reach. When a document has steps, in-file reference that should be disclosed buries them and turns attending to them into a coin-flip: a variance lever, not just a legibility one.
|
|
40
|
+
|
|
41
|
+
**Co-location** is the within-file companion: where the ladder decides _how far down_ a piece sits, co-location decides _what sits beside it_ once there. Keep a concept's definition, rules, and caveats under one heading rather than scattered, so reading one part brings its neighbours with it. The test: the document should read like documentation written for the agent. Grouped material reads that way; scattered material does not. (Distinct from duplication: that repeats one meaning in two places; scattering fragments one meaning across many.)
|
|
42
|
+
|
|
43
|
+
**Sprawl** is the failure mode here: a document simply too long, even when every line is live and unique. Attention thins across the excess, and every extra line is one more to keep relevant. The cure is the ladder: disclose reference behind pointers, and split by branch or sequence so each path carries only what it needs.
|
|
44
|
+
|
|
45
|
+
## Steps and completion criteria
|
|
46
|
+
|
|
47
|
+
Every step ends on a **completion criterion**, the condition that tells the agent the work is done. Two properties make it a lever:
|
|
48
|
+
|
|
49
|
+
- **Clarity**: can the agent tell done from not-done? A vague bound ("understanding reached") invites **premature completion**: ending the step before it is genuinely done, attention slipping to _being done_. The visible steps still ahead (the **post-completion steps**) supply the pull; the criterion's clarity is the resistance. Defend in order: **sharpen the bound first** (local and cheap); only if it is irreducibly fuzzy _and_ you observe the rush, hide the later steps by splitting the sequence. Hiding only works across a real context boundary (a hand-off or a subagent dispatch; an inline call leaves the later steps in context and clears nothing).
|
|
50
|
+
- **Demand**: how much it requires. "Every modified model accounted for" forces thorough work where "produce a change list" does not. Demand drives **legwork** (the digging the agent does within the work, latent in the wording rather than written as its own step), and it is not step-bound: "every rule applied" binds a body of flat reference just as "every step done" binds a sequence, which is how an all-reference document still carries an exhaustiveness bar.
|
|
51
|
+
|
|
52
|
+
The strongest criteria are both checkable and exhaustive.
|
|
53
|
+
|
|
54
|
+
## When to split
|
|
55
|
+
|
|
56
|
+
Splitting one document into two spends one of the two loads, so split only when the cut earns it:
|
|
57
|
+
|
|
58
|
+
- **By sequence**: split a run of steps where the post-completion steps tempt the agent to rush the one in front of it. Keeping them out of view drives more legwork on the current task. Beware the reverse: merging sequences exposes each step's later steps to what follows, inviting premature completion.
|
|
59
|
+
- **By invocation**, skill-specific: see [`SKILL-MECHANICS.md`](SKILL-MECHANICS.md).
|
|
60
|
+
|
|
61
|
+
## Leading words
|
|
62
|
+
|
|
63
|
+
A **leading word** is a compact concept already living in the model's pretraining that the agent thinks with while running the document (_lesson_, _fog of war_, _tracer bullets_). Repeated as a token, never as a sentence, it accumulates a distributed definition and anchors a whole region of behaviour in the fewest tokens, by recruiting priors the model already holds. Coining your own works if you define it clearly, but a made-up word recruits no priors: you pay in definition tokens what a pretrained word gives free; reach for an existing word first.
|
|
64
|
+
|
|
65
|
+
It anchors twice. In the body, _execution_: the agent reaches for the same behaviour every time the word appears, and inside flat reference it focuses attention on a class of thing to look for. In a pointer, _invocation_: when the same word lives in your prompts, your docs, and your codebase, the agent links that shared language to the material and reaches it more reliably.
|
|
66
|
+
|
|
67
|
+
Hunt for opportunities to refactor with leading words. A triad spelled out at three sites, a pointer spending a sentence to gesture at one idea. Each is a passage begging to collapse into a single token:
|
|
68
|
+
|
|
69
|
+
- "fast, deterministic, low-overhead" → _tight_ (a _tight_ loop).
|
|
70
|
+
- "a loop you believe in" → _red_, turning a fuzzy gate into a binary observable state (the loop goes _red_ on the bug, or it doesn't).
|
|
71
|
+
|
|
72
|
+
You win twice: fewer tokens, and a sharper hook for the agent to hang its thinking on. Assume every document is carrying restatements that leading words retire. Go find them.
|
|
73
|
+
|
|
74
|
+
**Negation** is the failure mode beside this lever: steering by prohibition drags the forbidden behaviour into context and makes it _more_ available, not less. _Don't think of an elephant_, and the elephant is all there is; the negation is a weak modifier the strongly-activated concept overruns, so the ban half-reads as an instruction to do the thing. Prompt the **positive**: state the target behaviour ("write one-line comments") so the banned one is never spoken. A prohibition earns its place only as a hard guardrail you cannot phrase positively; even then, pair it with the positive target so attention lands on what to do.
|
|
75
|
+
|
|
76
|
+
## Pruning
|
|
77
|
+
|
|
78
|
+
- Keep each meaning in a **single source of truth**: one authoritative place, so changing the behaviour is a one-place edit. **Duplication** (the same meaning in more than one place) costs maintenance and tokens, and inflates a meaning's prominence on the ladder past its real rank. (The accidental inverse of a leading word, which repeats a token on purpose, never the meaning.)
|
|
79
|
+
- The **environment** is a source of truth too (`package.json` scripts, config files, the directory layout, `--help` output), and a document that restates it is a **cache**: a copy of a lookup, earning its load only when the lookup is expensive. Cache what the agent cannot find by looking: the unwritten convention, the reason behind a choice, the gotcha no config confesses. Leave the one-file, one-command lookups to the environment, where they cannot go stale.
|
|
80
|
+
- Check every line for **relevance**: does it still bear on what the document does? A line loses relevance by never bearing on the task (mere exposition, or a branch that should be disclosed) or by going stale as the behaviour or world it describes changes. Shorter documents are easier to keep relevant. Without a pruning discipline the default fate is **sediment**: stale layers that settle because adding feels safe and removing feels risky, until you must core down through them to find what is still live.
|
|
81
|
+
- Hunt **no-ops** sentence by sentence: an instruction the model already obeys by default pays load to say nothing. The test (does it change behaviour versus the default?) is model-relative, not reader-relative: two people disagreeing about a no-op disagree about the default, and settle it by running the document, not by debate. When a sentence fails, delete the whole sentence rather than trim words from it. The test also grades leading words: a word too weak to beat the default (_be thorough_ when the agent is already thorough-ish) is a no-op, and the fix is a stronger word (_relentless_), not a different technique.
|