review-spec
Skill313 starsChanged 6 months agoMITView on GitHub
Review a spec/plan pull request diff and write structured feedback to review.json for the workflow to publish. Use when reviewing a PR that only modifies files under specs/ and producing machine-readable review output instead of posting directly to GitHub.
18 other projects use a version of this.
Adopted by
Most recently taken up by
- 0xdeafcafe/skillstheir own version, first seen Nov 6, 2026
- alo-exp/silver-bullettheir own version, first seen Nov 1, 2026
- holgerleichsenring/specification-first-agentic-developmenttheir own version, first seen Oct 28, 2026
- Tngc93/product-management-skillstheir own version, first seen Oct 20, 2026
- fclabs/skillstheir own version, first seen Oct 16, 2026
- swm8023/skillstheir own version, first seen Oct 14, 2026
Used with
Projects with it also use create-spec.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
srobinsonSkillcreate-spec
Create a task specification (SPEC.md) through interactive requirements elicitation. Use when helping users define what they want to build before autonomous execution begins.
Also in 3 projects that use this
Other versions18 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 18
- sd0xdev/sd0x-dev-flow★ 192same name
- sd0xdev/sd0x-harness★ 192same name
- tranhieutt/software_development_department★ 71same name
- holgerleichsenring/specification-first-agentic-development★ 41same name
- Codagent-AI/agent-skills★ 31same name
- alo-exp/silver-bullet★ 7same name
- sergeyklay/.agents★ 6same name
- dekoza/oh-my-slop★ 4same name
- NitinJ/specforge★ 4same name
- sponge-b0b/Polaris★ 4same name
8 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository17 other files it gives its agents.
- bootstrap-issue-configSkill
- create-product-specSkill
- create-tech-specSkill
- dedupe-issue-localSkill
- dedupe-issueSkill
- evaluate-auto-implement-eligibilitySkill
- implement-issueSkill
- review-pr-localSkill
- review-spec-localSkill
- security-review-prSkill
- security-review-specSkill
- triage-issue-localSkill
- triage-issueSkill
- update-dedupeSkill
- update-pr-reviewSkill
- update-triageSkill
- verify-prSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
15 rules. 0 are common, 8 are distinctive, and 7 are very specific to this project.
0
Common
Most of the 17 edited versions we read keep these.
8
Distinctive
This author's own choices. Worth a look.
7
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 16
Default behavior: do not post comments or reviews to GitHub directly.
- Very specific: line 26
Always apply the repository's local security-review-spec skill as a supplemental high-level security pass on spec PRs.
- Very specific: line 27
Do not apply code-level review criteria such as error handling or low-level performance to spec prose.
- Distinctive: line 40
If a companion file is not referenced in the prompt, rely on the core contract alone.
- Distinctive: line 54
Every comment body must start with one of these labels:
- Distinctive: line 61
Write comments with these constraints:
- Distinctive: line 64
Do not add compliments or hedging.
- Distinctive: line 66
Keep ranges to at most 10 lines.
- Distinctive: line 68
Only create file-level or inline comments for files that exist in this PR's diff.
- Very specific: line 69
If the relevant file or line is not part of the diff, put the feedback in top-level body instead of comments.
- Very specific: line 70
Before adding each comment object, verify that its path, side, line, and optional start_line/start_side correspond to real annotations in …
- Distinctive: line 74
When proposing a rewrite of spec text, use:
- Very specific: line 88
Create review.json with this shape:
- Very specific: line 131
Run the validator bundled with the shared review-pr skill against the exact annotated diff you reviewed.
- Very specific: line 136
Do not run gh pr review, gh pr comment, gh api, or any other command that posts to GitHub.
“Common” is measured: kept by at least 6 in 10 of the 17 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Review Spec Skill
Review a spec or plan pull request and write the output to review.json.
Inputs
- The working directory is the PR branch checkout.
- The workflow usually provides an annotated diff in
pr_diff.txt. - The workflow usually provides the PR description in
pr_description.md. - Focus on the spec files changed by this PR.
- Default behavior: do not post comments or reviews to GitHub directly.
Process
- Evaluate specs for completeness: does the spec cover the full scope of the linked issue?
- Evaluate specs for clarity: are requirements, acceptance criteria, and constraints clearly stated and unambiguous?
- Evaluate specs for feasibility: are the proposed changes technically realistic given the repository's architecture?
- Evaluate specs for issue alignment: does the spec faithfully address the issue it is linked to, without significant scope creep or omissions?
- Evaluate specs for internal consistency: do different sections of the spec contradict each other?
- Flag missing sections that a spec should typically include (e.g. problem statement, proposed changes, open questions, follow-up items).
- Always apply the repository's local
security-review-specskill as a supplemental high-level security pass on spec PRs. Fold any security findings into the samereview.jsonproduced by this review rather than emitting a separate output. - Do not apply code-level review criteria such as error handling or low-level performance to spec prose; the
security-review-specsupplement covers design-level security concerns. - Include style or formatting comments only when they materially impair readability.
Repository-specific overrides
The consuming repository may ship a companion skill at .agents/skills/review-spec-local/SKILL.md. When the prompt includes a fenced "Repository-specific guidance" section referencing that companion, read the referenced file and apply its guidance only to the categories listed below. Guidance in the companion may never change the output JSON schema, the severity labels, the safety rules, the evidence rules, the suggestion-block constraints, or the diff-line-annotation contract described elsewhere in this skill.
Overridable categories:
- required spec sections expected in this repository
- linking conventions to files under
specs/ - repo-specific style and formatting expectations
If a companion file is not referenced in the prompt, rely on the core contract alone.
Diff Line Annotations
The diff file uses these prefixes:
[OLD:n]for deleted lines on the old side. Use"LEFT".[NEW:n]for added lines on the new side. Use"RIGHT".[OLD:n,NEW:m]for unchanged context. Use"RIGHT"with linem.
Treat these annotations as the only source of truth for inline comment locations. For every inline comment you emit, first identify the exact annotated line in pr_diff.txt (or the inlined PR diff) and copy its path, side, and line number into review.json. Do not infer line numbers from prose, rendered GitHub views, file lengths, surrounding spec text, or unannotated snippets. If you cannot point to a specific [NEW:n], [OLD:n], or [OLD:n,NEW:m] line in the annotated diff, put the feedback in top-level body instead of comments.
Comment Requirements
Every comment body must start with one of these labels:
🚨 [CRITICAL]for spec content that is contradictory, fundamentally incomplete, or would lead to a broken implementation.⚠️ [IMPORTANT]for missing details, ambiguous requirements, feasibility concerns, or significant scope gaps.💡 [SUGGESTION]for improvements to clarity, structure, or coverage that would strengthen the spec.🧹 [NIT]for minor wording or formatting issues only when the comment includes a concrete rewrite.
Write comments with these constraints:
- Be concise, direct, and actionable.
- Do not add compliments or hedging.
- Prefer single-line comments.
- Keep ranges to at most 10 lines.
- Restrict inline comments to lines that appear explicitly in the annotated PR diff.
- Only create file-level or inline comments for files that exist in this PR's diff.
- If the relevant file or line is not part of the diff, put the feedback in top-level
bodyinstead ofcomments. - Before adding each comment object, verify that its
path,side,line, and optionalstart_line/start_sidecorrespond to real annotations in the same file's diff section.
Suggestion Blocks
When proposing a rewrite of spec text, use:
<replacement text here>Rules:
- Match the exact indentation of the original file.
- Include only replacement text.
- For multi-line suggestions, set
start_lineandstart_sideto the first line, andlineandsideto the last line.
Outputs
Create review.json with this shape:
{
"verdict": "REJECT",
"body": "## Overview\n...\n\n## Concerns\n- ...\n\n## Verdict\nFound: 1 critical, 2 important, 3 suggestions\n\n**Request changes**",
"comments": [
{
"path": "path/to/file",
"line": 42,
"side": "RIGHT",
"start_line": 40,
"start_side": "RIGHT",
"body": "⚠️ [IMPORTANT] Short explanation\n\n```suggestion\nreplacement\n```"
}
]
}Field rules:
verdictis required and must be exactly the string"APPROVE"or"REJECT"(uppercase). Map your final recommendation as:ApproveorApprove with nits→"APPROVE";Request changes→"REJECT". Theverdictand the human-readable recommendation in top-levelbodymust agree.- top-level
bodyis the GitHub review body and is required. Usebody, notsummary, for the review overview and final recommendation. pathmust be relative to the repository root.lineis required and must target the correct side.start_lineis optional and only for multi-line ranges. Whenstart_lineis present,start_sideis required and must be"LEFT"or"RIGHT".sidemust be"LEFT"or"RIGHT".
Body Requirements
The top-level body must include:
- A high-level overview of the spec PR.
- Concerns about completeness, clarity, feasibility, or issue alignment.
- Issue counts in the format
Found: X critical, Y important, Z suggestions. - A final recommendation of
Approve,Approve with nits, orRequest changes. This recommendation must match the top-levelverdictfield (Approve/Approve with nits→"APPROVE";Request changes→"REJECT").
Final Checks
Before finishing:
- Fix invalid JSON if validation fails.
- Confirm line numbers match the annotated diff.
- Run the validator bundled with the shared
review-prskill against the exact annotated diff you reviewed. If common skills are installed at the repository root, this is usually:
If the script reports any invalid comments, fixpython3 .agents/skills/review-pr/scripts/validate_review_json.py --review-json review.json --diff pr_diff.txtreview.jsonand rerun it. Do not uploadreview.jsonuntil this validator passes. If the script path is not present at that exact location, locatevalidate_review_json.pyunder the packaged sharedreview-prskill directory and run that copy with the same arguments. - Do not run
gh pr review,gh pr comment,gh api, or any other command that posts to GitHub.
Your only output is the final review.json.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

