agentleFS
SkillkeelSkillkeel/skillkeel-starter/skills/pr-description/SKILL.md

pr-description

Skill3 starsChanged 57 days agoMITView on GitHub

Use when the user asks to open a pull request, write a PR description, or summarise a branch for review. Builds the description from the full branch diff against the base and from commit messages, and includes a test plan with real commands.

  • Commits and pushes

94 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use ao-desktop-dev, bug-triage and 7 more.

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.
  • agentlab-inSkill

    ao-desktop-dev

    Launch, restart, or troubleshoot the real AO Electron desktop app from this repository; run a checkout against isolated or real local AO data; combine PR branches for local UI review; and diagnose stale Electron processes, port conflicts, or preload bridge mismatches. Use whenever asked to run, open, show, or visually verify AO frontend changes in the actual desktop app rather than ao preview, dev:web, or mock data.

    Also in 4 projects that use this

  • jMertaSkill

    bug-triage

    Use when the user reports a bug, regression, runtime error, failing build, or broken test and wants reproduction, diagnosis, root-cause analysis, or an authorized fix. Isolates the shared cause and verifies the smallest relevant change.

    Also in 4 projects that use this

  • saffron-healthSkill

    address-review

    Address PR review comments systematically. Use when responding to code review feedback on a pull request.

    Also in 3 projects that use this

  • NVIDIASkill

    writing-docs

    Use when adding or changing user-facing behavior or documentation in Megatron-Energon, or when creating new .py, .sh or .md files that need license headers.

    Also in 3 projects that use this

  • PydanticSkill

    i-have-adhd

    Shape every response for an ADHD reader who reviews the work but does not do the coding — the agent does. Use whenever responding to ANY message — coding, debugging, planning, casual. Lead with the result or the decision. Surface anything needing the user's input as a structured question, never buried in prose they'll skim past. No preamble, no recap, no closers. State errors matter-of-factly. Make finished work visible. Trigger even on casual messages and even when brevity wasn't requested.

    Also in 3 projects that use this

  • pproencaSkill

    refactoring

    Code refactoring best practices based on Martin Fowler's catalog and Clean Code principles. This skill should be used when refactoring existing code, improving code structure, reducing complexity, eliminating code smells, or reviewing code for maintainability. Triggers on tasks involving extract method, rename, decompose conditional, reduce coupling, or improve readability.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 89 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write, in this order, using the template below.

    line 13
  2. Very specific:

    If gh is available and the user asked to open the PR: gh pr create --title "<subject>" --body "$(cat <<'EOF' ...

    line 14
  3. Very specific:

    Test plan commands must be ones that actually exist in the repo (check package.json, Makefile, pyproject.toml).

    line 35
  4. Distinctive:

    Call out schema/migration changes, config changes, and dependency bumps explicitly.

    line 36
  5. Distinctive:

    Do not claim tests pass unless you ran them in this session.

    line 37

“Common” is measured: kept by at least 6 in 10 of the 89 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.

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

pr-description

A PR description is a reviewer's map: what changed, why, how to verify, what is risky.

Procedure

  1. Determine base: git rev-parse --abbrev-ref --symbolic-full-name @{u} or ask; default origin/main. Fetch first: git fetch origin.
  2. Collect evidence: git log --oneline <base>..HEAD, git diff --stat <base>...HEAD, and read the diff for anything non-trivial (git diff <base>...HEAD -- <paths>).
  3. Write, in this order, using the template below. Keep the whole thing under ~250 words unless the diff is large.
  4. If gh is available and the user asked to open the PR: gh pr create --title "<subject>" --body "$(cat <<'EOF' ... EOF)" and print the URL. Otherwise output the markdown.

Template

## Summary
One paragraph: the problem and the approach. Link the issue.

## Changes
- Bullet per logical change, referencing files/modules (not every file).

## Test plan
- [ ] `<exact command>`: what it proves
- [ ] Manual step, if any

## Risk / rollback
What could break, how to revert (`git revert <sha>` or feature flag).

The body ends with the Risk / rollback section. Nothing comes after it.

Rules

  • Title ≤ 70 chars, imperative, matches the primary commit type (feat:/fix:).
  • Test plan commands must be ones that actually exist in the repo (check package.json, Makefile, pyproject.toml). Never invent npm test if there is no test script.
  • Call out schema/migration changes, config changes, and dependency bumps explicitly.
  • Do not claim tests pass unless you ran them in this session; say "not run" otherwise.
  • No tool attribution footer ("Generated with …", a robot emoji line, Co-Authored-By) unless the repo's CONTRIBUTING or the user asks for it. The harness may append such a line to PR bodies on its own; this skill's output is complete without it, so do not add one and do not leave room for one. If the user wants attribution off everywhere, point them to the attribution setting in Claude Code's settings.json (includeCoAuthoredBy).

Verify

Maintainers: bash evals/run.sh /tmp/skillkeel-evals pr-description from the plugin root runs this case and grades it; records and transcripts sit in evals/pr-description/. evals/pr-description/: fixture branch with 3 commits (feat + fix + docs) and a migration file; expected: migration called out under Risk, test plan uses the repo's real make test.

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.