mcpField
G
github-pr-workflow

github-pr-workflow

github.com/marcioaltoeDevelopment073 installsUpdated 1d ago
Repository

About github-pr-workflow

github-pr-workflow is a skill for preparing and maintaining GitHub pull requests. It guides developers through branch cleanup, clear PR descriptions, verification evidence, review replies, and merge readiness.

Key features

  1. 01Clean up branches and commits
  2. 02Write clear PR titles and descriptions
  3. 03Document tests and verification evidence
  4. 04Respond to review comments and push fixes
  5. 05Check merge readiness

Use cases

  1. 01Prepare a PR for a completed change
  2. 02Address review feedback and push fixes
  3. 03Bring a stale PR up to date

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/marcioaltoe/skills --skill github-pr-workflow

After installing, type/github-pr-workflowin Claude Code to confirm it loaded.

Details

From the project README

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 " — 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.

Comments

Markdown supported