agentleFS
oopsla5xxoopsla5xx/oops-skills/.claude/skills/create-pr-description/SKILL.md

create-pr-description

Skill4 starsChanged 3 months agoMITView on GitHub

Generate a pull request description by filling in the .github/PULL_REQUEST_TEMPLATE.md from spec, git diff, and commit history. Outputs ready-to-use text or creates PR via gh CLI. Run as part of Phase 4 ship.

  • Commits and pushes

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 1

    1. dannys-code-corner/incan★ 73same name

    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 repository12 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run all in parallel:

    line 16
  2. Very specific:

    Read spec: .ai/tasks/<task-name>.md (Goal, Scope, Test plan, Constraints)

    line 29
  3. Distinctive:

    Changes: Use git diff --stat to get the file list, add 1 line of context for important files.

    line 67
  4. Distinctive:

    Notes for reviewer: Only include what a reviewer CANNOT know from the code:

    line 74
  5. Distinctive:

    Use the fallback structure:

    line 106
  6. Distinctive:

    Do not copy-paste commit messages as the description: Commit messages describe individual steps.

    line 122

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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

Create PR Description

Fill in the PR template from .github/PULL_REQUEST_TEMPLATE.md based on the spec and git history. Output is ready to paste into GitHub or use with gh pr create.


Run

Step 1 — Gather context

Run all in parallel:

# Template
cat .github/PULL_REQUEST_TEMPLATE.md 2>/dev/null \
  || cat .github/pull_request_template.md 2>/dev/null \
  || echo "(no template found)"

# Git summary
git log main...HEAD --oneline
git diff --stat main...HEAD

Read spec: .ai/tasks/<task-name>.md (Goal, Scope, Test plan, Constraints)

Step 2 — Map each section of the template

For each section in the template, pull content from the corresponding source:

SectionSource
WhatGoal in spec — 1-2 concise sentences
WhyReason from clarify-scope discussion, or Constraints in spec
Changesgit diff --stat + Scope in spec
Test planTest plan items in spec (convert to checklist)
Manual test guideLink to <task-name>-manual-tests.md if it exists
ChecklistFill in real test commands from .ai/commands.md
Notes for reviewerConstraints, trade-offs, or important gotchas from spec

Step 3 — Write the description

Rules:

What: Describe WHAT, not HOW. After reading, the reader immediately knows what the feature/fix is.

# Good
Add password reset via email — users can request a reset link that expires in 1 hour.

# Bad
Implement the reset token logic and add the API endpoints for password reset flow.

Why: Business or technical reason. Do not re-explain WHAT.

# Good
Required by auth security audit — tokens previously had no expiry.

# Bad
Because we need to allow users to reset their password.

Changes: Use git diff --stat to get the file list, add 1 line of context for important files.

- `src/auth/reset-token.ts` (new) — token generation and validation
- `src/api/routes/auth.ts` — 2 new endpoints: request + confirm
- `src/email/templates/` — reset-password email template

Notes for reviewer: Only include what a reviewer CANNOT know from the code:

  • Trade-offs considered
  • Decisions to skip a particular approach and why
  • Known limitations or follow-up work needed

Step 4 — Output

If gh CLI is available:

gh pr create \
  --title "<type>: <short name>" \
  --body "$(cat <<'EOF'
<description content>
EOF
)"

If gh is not available: Print the full description, ready to paste into GitHub.

PR title format:

feat: <what>       ← new feature
fix: <what>        ← bug fix
refactor: <what>   ← no behavior change
chore: <what>      ← tooling, deps, config

If the project has no PR template

Use the fallback structure:

## What
## Why
## Changes
## Test plan
## Notes for reviewer

Then suggest creating .github/PULL_REQUEST_TEMPLATE.md for the project (template available in oops-skills).


Gotchas

Do not copy-paste commit messages as the description. Commit messages describe individual steps; a PR description describes the entire change as a single unit.

"What" and "Why" are often confused. What = result/output. Why = reason for existence. If a sentence starts with "Because" or "In order to" → that is Why, not What.

Checklist must have real commands. - [ ] Tests pass (npm test) is more useful than - [ ] Tests pass.

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.