agentleFS
Sign inStart free
MicrosoftKnown publishermicrosoft/amplifier-app-paperclip/packages/skills-catalog/catalog/bundled/software-development/github-pr-workflow/SKILL.md

github-pr-workflow

Skill1 starsChanged 5 months agoMITView on GitHub

Prepare a GitHub pull request from a feature branch — branch hygiene, commit shape, title/body, verification notes, screenshots for UI work, and replies to review comments.

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 26 edited versions we read keep these.

  • 4

    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. Very specific:

    Remove debug prints, commented-out code, and TODO markers that are not tracked.

    line 34
  2. Very specific:

    If the repo uses an issue prefix convention (PAP-1234:, [security]), follow it.

    line 40
  3. Distinctive:

    If you disagree with feedback, say so with one sentence of rationale and let the reviewer decide.

    line 77
  4. Distinctive:

    All required checks green.

    line 82
  5. Distinctive:

    All review comments resolved.

    line 83
  6. Distinctive:

    Delete the branch after merge unless it is a long-lived integration branch.

    line 86

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

GitHub Pull Request Workflow

Ship a PR a reviewer can land without follow-up clarifying questions. The aim is high signal in the title and body, evidence the change works, and clean replies when feedback comes in.

When to use

  • You are about to open a PR for a change that is functionally complete.
  • A reviewer left comments and you need to respond and push fixes.
  • A PR has been open more than a day and needs to be brought back into shape (stale conflicts, missing description, missing verification).

When not to use

  • The change is not yet functionally complete. Finish the work first; draft PRs that bounce on review are noise.
  • The repository uses a non-GitHub forge. Adjust to that forge's conventions; do not force GitHub-isms.

Branch hygiene before opening

  • Rebase or merge from the target base so the diff is current.
  • Squash WIP commits into reviewable units. Prefer one commit per logical change; do not force one-commit-per-PR if the work is genuinely multi-step.
  • Confirm tests, typecheck, and lint pass locally. Note any deliberate skips in the PR body.
  • Remove debug prints, commented-out code, and TODO markers that are not tracked.

PR title

  • Imperative mood, under 70 characters.
  • Lead with the user-visible change, not the file touched. Allow CSV export from reports table beats Update reports.tsx.
  • If the repo uses an issue prefix convention (PAP-1234:, [security]), follow it.
  • No trailing period.

PR body

Use this structure:

## Summary
- 1–3 bullets describing what changed and why.

## Implementation notes
- Anything non-obvious in the diff: trade-offs, dropped alternatives, gotchas.
- Migration or config implications.

## Verification
- The exact commands or steps you ran.
- Screenshots or short clips for UI changes (required if pixels moved).
- Edge cases you exercised by hand.

## Risk and rollback
- What breaks if this is reverted, and how to revert cleanly.

Skip the Risk and rollback section only for clearly trivial PRs (typos, docs).

Verification evidence

  • Tests passing in CI is necessary, not sufficient. Reviewers also need to know the change behaves correctly end to end.
  • For UI work, include screenshots of the golden path and one edge case. Tag dark and light mode if the project supports both.
  • For migrations, include a dry-run plan and reversal steps.
  • For performance changes, include a before/after measurement, not adjectives.

Replying to review comments

  • Reply on every comment, even with just "fixed in <commit-sha>" — silent fixes leave the reviewer guessing.
  • Push fixes as new commits while review is active; do not amend during review unless the reviewer agrees.
  • If you disagree with feedback, say so with one sentence of rationale and let the reviewer decide. Don't escalate over comments.
  • Re-request review explicitly after pushing changes.

Merge checklist

  • All required checks green.
  • All review comments resolved.
  • PR title/body still accurate (update if scope changed mid-review).
  • Linked issue moves to in_review or done per project convention.
  • Delete the branch after merge unless it is a long-lived integration branch.

Anti-patterns

  • PR description that says "see commits". Reviewers should not need to read the log.
  • Mixing refactor and behavior change in the same PR with no separation in the body.
  • "Address feedback" commits that bundle unrelated edits. One commit per round of feedback is fine; one commit for everything in flight is not.
  • Force-pushing during active review without telling the reviewer.

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.

Check your setup, free