agentleFS
tbhbtbhb/vale-ai-tells/.claude/skills/review-pr-description/SKILL.md

review-pr-description

Skill118 starsChanged 37 days agoMITView on GitHub

Review a drafted pull request description in PR_AGENTDESC.md against the branch it would publish, as an independent agent, for what mechanical checking can't see. Covers claims the diff doesn't support, counting, provenance filler, restating the diff, a title describing one commit rather than the branch, and whether the branch is one coherent change. The pr skill invokes this before opening every pull request, passing the repository root.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Treat that path as the repository under review.

    line 19
  2. Distinctive:

    Run these before judging anything:

    line 27
  3. Distinctive:

    Read the diff instead. Your job starts where looking at the file stops.

    line 49
  4. Distinctive:

    Do this even when a finding sends you back into a section you already cleared.

    line 95

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Review a drafted pull request description

Review a drafted pull request description against the branch it would publish, then return a verdict. You're the independent check. You didn't write this description and you didn't watch the work happen, so read what it claims rather than what its author meant to claim.

The repository

$ARGUMENTS

Treat that path as the repository under review. An empty value means the current working directory. Bind it once and use it throughout:

REPO="${ARGUMENTS:-$(pwd)}"

Gather the inputs

Run these before judging anything:

  • cat "$REPO/PR_AGENTDESC.md" for the draft
  • sed -n '/^base:/p' "$REPO/PR_AGENTDESC.md" for the base branch the rest of these need
  • git -C "$REPO" log --reverse --pretty=format:'--- %h%n%B' <base>..HEAD for the commits that would land
  • git -C "$REPO" diff --name-status <base>...HEAD for the paths
  • git -C "$REPO" diff <base>...HEAD for the diff itself
  • cat "$REPO/.github/pull_request_template.md" for what each section is asking

A missing or empty draft, or a branch with nothing to land, is itself a finding. Report it and stop.

What's already settled

The writer runs a mechanical validator until it reports a clean run before handing you anything, and the caller runs it again afterwards, so leave its rules alone. It has already settled:

  • the frontmatter structure, and the title's length and Conventional Commits form
  • section presence, section order, and sections left empty
  • surviving template comments, unclosed fences, and links pointing nowhere
  • whether every path the draft puts in backticks exists

Repeating any of that wastes the round trip.

Read the diff instead. Your job starts where looking at the file stops.

What to check

Work these four groups. Quote the exact offending text in each finding and give the fix.

Truthfulness

The description covers this branch and no other.

  • Flag any claim the diff doesn't support. A description that mentions a behavior, a flag, or a guarantee absent from the diff is wrong, whatever else it gets right.
  • Flag counts of any kind: files, lines, tests, commits, percentages. A count goes stale the moment other work merges, and it pads a description rather than informing it.
  • Flag results nobody verified. The Verification section names commands, so check that the commands suit the change. A Go change verified only by a Markdown linter reports nothing about itself.
  • Flag a Risk section that says nothing risks anything when the diff touches behavior, and flag invented risk when the diff touches documentation alone.

Substance

Each section addresses its own question, and the template says which.

  • Flag a Summary that restates the diff. Adds a helper to foo.go and calls it from bar.go describes a diff the reader can already read.
  • Flag a Why that repeats the Summary in longer words, or that doesn't explain anything a reader couldn't recover from the diff.
  • Flag provenance filler: requests, review rounds, sessions, prompts, iterations, models, assistants, tools. None of that belongs in a description.
  • Flag selling: robust, comprehensive, significantly, seamlessly, powerful, elegantly, and their neighbors.

Fit

The description covers the whole branch, not the commit its author happened to write last.

  • Flag a title describing one commit when the branch has more than one. That title becomes the squash subject on the default branch, so it has to describe what the whole branch does.
  • Flag a Summary that covers some commits and drops others.
  • Flag labels that misreport the change: a documentation label on a branch touching behavior, or a bug label on a branch fixing nothing.
  • Flag draft: false on a branch whose own description says the work is unfinished.

Coherence

Judge the branch, not the description.

  • Does the branch carry one change that a reviewer can understand as a whole and that merges or reverts as a unit?
  • Flag a branch mixing unrelated work, and list the pull requests it should split into. Reviewers miss things in a branch that changed three unrelated areas.
  • A change plus its tests, or a change plus the documentation describing it, counts as one change. Leave that alone.
  • Size alone isn't a finding. A wide mechanical rename counts as one change. A small diff touching two unrelated subsystems doesn't.

Sweep before you write the verdict

A fault you found once is rarely alone. Take each finding you have and read the whole draft again for the same fault. A list that stops short of the diff, a claim scoped wider than the evidence, a count standing where a name belongs, a sentence selling rather than saying. Where the draft holds one, look for the second. Where instances share a fix, report them as one finding that lists each.

Do this even when a finding sends you back into a section you already cleared. The draft in front of you changed since the last pass, and a claim that held then may not hold now.

An instance you leave for the next pass costs a writer round and a reviewer round to say what this verdict could have said. None of that invites padding. Everything in the verdict still has to be something you can point at.

What to return

Your verdict is what lets the pull request proceed. A hook on the caller's side reads the line below and signs the draft you cleared. Keep the wording exact, because a verdict that hook can't parse leaves the pull request blocked. Write nothing to disk yourself, and don't edit the draft to make it pass. Reporting the finding is the job.

Return the verdict block and stop there. Skip the preamble, the diff summary, and the praise.

VERDICT: PASS

or

VERDICT: CHANGES REQUIRED

1. [truthfulness] <what is wrong>
   text: <the exact offending text>
   fix:  <the specific correction>

2. [coherence] <what is wrong>
   text: <the exact offending text>
   fix:  <the specific correction>

Tag each finding truthfulness, substance, fit, or coherence.

Return PASS when the draft holds up. A clean description counts as a real outcome, and inventing a finding to look thorough wastes the round trip. Report only what you can point at in the draft or the diff.

Your findings go straight back to write-pr-description as its next instructions, so write each one so that agent can act on it without seeing this conversation. Identify the section and quote the offending text, then give the replacement.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.