yaohuangguanyaohuangguan/agent-playbook/skills/write-pull-request/SKILL.md

write-pull-request

Skill1 starsChanged 2 days agoMITView on GitHub

Write clear commits and pull requests that a reviewer can check quickly. Use this whenever you commit, push, open or update a pull request, or draft a commit message or PR description.

We split this skill into the rules it gives an agent

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

0
Common
Most of the 3 edited versions we read keep these.
5
Distinctive
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
could be automatic: a setting could enforce it

Very specific:
Finish verification first: Follow verify-and-report.
line 19
Distinctive:
Follow the project's format: Run git log --oneline -20, and match it.
line 30
Distinctive:
Branch from the current default branch: Never push directly to it unless the project does that and the user asked.
line 36
Distinctive:
Write the PR: Use the template below. Use real numbers, and only ones you measured.
line 39
Distinctive:
Check CI after pushing: If it fails, read the log and fix the cause.
line 42
Distinctive:
Use this as the pull request description:
line 73

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

Write a pull request

A reviewer needs to know why the change exists, what it does and how you know it works. Writing those down well is often the difference between a quick review and a long one.

When to use

Any commit or pull request. Commit, push or open a PR only when the user asked you to, because these are visible to other people.

Steps

Finish verification first. Follow verify-and-report.
Check what you are committing.
```
git status --short
git diff --staged
```
Stage named files. Avoid git add ., which can pick up secrets and scratch files.
Follow the project's format. Run git log --oneline -20, and match it. Check for a commit convention or a PR template in the repository.
Keep commits to one purpose. Explain why in the message. The diff already shows what changed.
Branch from the current default branch. Never push directly to it unless the project does that and the user asked.
Write the PR. Use the template below. Use real numbers, and only ones you measured. Keep it short enough to read.
Check CI after pushing. If it fails, read the log and fix the cause. Do not merge unless you were asked to.

Stop and ask when

You were not asked to commit or push.
Hooks fail. Fix the cause, and do not bypass them with --no-verify.
You would need to force push a shared branch.

Common mistakes

Tempting move	Why it fails	Do this instead
Commit message "fix bug"	Useless in history	Say what broke and why
Mix a refactor with a feature	Hard to review	Split the commits
Paste the diff into the description	Adds nothing	Explain the reason
Claim tests that you did not run	A false record	List only what you ran
Hide known gaps	Reviewers will miss them	List them

Example

fix(billing): stop double refunds on webhook retries

The provider retries webhooks after a timeout, and `applyRefund` had no duplicate
check, so a retry credited the customer again. Store the event id in the same
transaction, and skip events already seen.

Report

Use this as the pull request description:

## Why
<The problem and its evidence: numbers, logs or links.>

## Change
<What changed, by area. Mention behaviour that stays the same on purpose.>

## Validation
<Commands and results. For a bug fix, how the old code fails.>

## Not included
<Known gaps, follow-ups and anything unverified.>

Download now (ZIP)

Other versions5 projects use a version of this.
Word for word · 2
Remote-Arc/remote-arc★ 5100% same
yaohuangguan/remote-arc★ 5100% same
Edited · 0
None found.
Wrote their own version · 3
DataDog/dd-trace-rb★ 417same name
venables/skills★ 1same name
dabstractor/agent-skills★ 0same 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 repository14 other files it gives its agents.
- AGENTS.mdAGENTS.md
- audit-test-suiteSkill
- change-data-safelySkill
- debug-failureSkill
- fix-flaky-testSkill
- hand-off-workSkill
- implement-changeSkill
- orient-in-codebaseSkill
- refactor-safelySkill
- review-codeSkill
- secure-changeSkill
- use-external-apiSkill
- verify-and-reportSkill
- write-testsSkill

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.

Check your setup, free