Skip to content

Commit ae0ff77

Browse files
committed
Add review-draft skill and drafting convention
Adds a review-draft skill that reviews a durable artifact (issue, PR, or commit messages) along five dimensions before it is filed, dispatching review subagents and adjudicating their findings. Adds a "Drafting durable artifacts" convention to AGENTS.md pointing to it, so the review-before-filing practice is a documented team norm rather than an ad hoc habit.
1 parent f4ec24a commit ae0ff77

2 files changed

Lines changed: 79 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,14 @@ git config commit.template .gitmessage
8484
Subject line: imperative mood, 50 chars or less. Body (optional): explain why, not what. Reference
8585
issues with `Closes #n` or `Relates to #n`.
8686

87+
### Drafting durable artifacts
88+
89+
Before filing a durable, outward-facing artifact (a GitHub issue, a PR description, or a
90+
commit-message set), review and revise it first. Do not file the first draft. Run the
91+
`review-draft` skill, which checks the draft for quality, template adherence, voice, punctuation
92+
(no em dashes), and house style, then revises. Filing happens only after the caller or user
93+
approves the revised draft.
94+
8795
## Issue templates
8896

8997
Use the template that best fits the work. GitHub surfaces these when you open a new issue.

skills/review-draft/SKILL.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
name: review-draft
3+
description: Reviews a durable, outward-facing draft (a GitHub issue, a PR description, or a commit-message set) before it is filed. Dispatches review subagents across defined dimensions, adjudicates their findings, and revises. Use before creating an issue or PR, or finalizing commit messages.
4+
---
5+
6+
# Review Draft
7+
8+
Reviews a draft before it ships and returns a revised version. This skill is an orchestrator:
9+
it dispatches review subagents, adjudicates their findings, and applies the ones it agrees with.
10+
It does not file anything; filing stays with the caller after the draft is approved.
11+
12+
## When to use
13+
14+
Before filing any durable, outward-facing artifact:
15+
16+
- a GitHub issue
17+
- a pull request description
18+
- a commit message or a set of commit messages
19+
20+
Skip it for throwaway or internal scratch text that no one else will read.
21+
22+
## Dimensions
23+
24+
Review the draft along these five dimensions. Each is a separate lens; do not collapse them.
25+
26+
1. **Quality.** Accurate, complete, and useful to the reader. Claims are verifiable. Nothing
27+
misleading. Test-plan items (for a PR) are actually checkable.
28+
2. **Template adherence.** Matches the target template's sections, order, and conventions. For
29+
issues, the relevant `.github/ISSUE_TEMPLATE/` file. For PRs, `.github/PULL_REQUEST_TEMPLATE.md`.
30+
For commits, the `.gitmessage` scaffold (imperative subject 50 chars or less, body explains why).
31+
3. **Voice.** Warm but professional, plain language where the audience is mixed, concise by cutting
32+
filler rather than clipping into fragments, complete sentences, "we" for shared decisions.
33+
4. **Punctuation.** No em dashes (hard rule). En dashes only for genuine numeric ranges.
34+
5. **House style and stated preferences.** Anything the repo's conventions or the requester has
35+
asked for.
36+
37+
## Steps
38+
39+
### 1. Gather inputs
40+
41+
Identify the draft text, the artifact type (issue / PR / commit), and the matching template file.
42+
Read the template so the review can check adherence against it.
43+
44+
### 2. Dispatch reviewers
45+
46+
Dispatch review subagents in parallel, using a cheap model. Either one reviewer per dimension or a
47+
single focused reviewer covering all five; prefer splitting when the draft is large or high-stakes.
48+
Each reviewer must:
49+
50+
- report findings as a list, each with a location/quote, the issue, a concrete suggested fix, and a
51+
severity (BLOCKER / MAJOR / MINOR / NIT);
52+
- run a literal em-dash check and report every hit;
53+
- end with a one-paragraph verdict.
54+
55+
### 3. Adjudicate
56+
57+
For each finding, decide whether you agree. Do not apply findings blindly. Where you disagree,
58+
record your reasoning and reject the finding rather than applying it. If your platform supports
59+
replying to a reviewer, a brief exchange can resolve genuine ambiguity before you decide. Reject
60+
findings that are wrong or that misread the draft's purpose, and say why.
61+
62+
### 4. Revise and present
63+
64+
Apply the findings you accept. Present the revised draft to the user for approval. Note any finding
65+
you rejected and the reason. Do not file the artifact; that is the caller's step once approved.
66+
67+
## Notes
68+
69+
- Keep reviewers cheap and the adjudication in a more capable model.
70+
- An em dash anywhere is at least a MAJOR finding and must be fixed before filing.
71+
- This skill complements the "Drafting durable artifacts" convention in `AGENTS.md`.

0 commit comments

Comments
 (0)