Skip to content
OpenSmartRoute
Skillv1.0.0

github-pr-workflow

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.

by paperclipai(0) 0 installs
Free
Sign in to install

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Imported from paperclipai/paperclip (packages/skills-catalog/catalog/bundled/software-development/github-pr-workflow/SKILL.md). Install upstream with npx skills add paperclipai/paperclip --skill github-pr-workflow. Copyright stays with the author.

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.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml
targets:
  - https://api.opensmartroute.ai/api/v1/registry/paperclipai-paperclip-github-pr-workflow/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

paperclipai-paperclip-github-pr-workflow.ocm.jsonjson
{
  "ocm": "1",
  "id": "paperclipai-paperclip-github-pr-workflow",
  "kind": "skill",
  "name": "github-pr-workflow",
  "description": "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.",
  "publisher": "paperclipai",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "github",
      "pull-requests",
      "code-review",
      "release",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "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."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/paperclipai/paperclip",
      "path": "packages/skills-catalog/catalog/bundled/software-development/github-pr-workflow/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/paperclipai/paperclip/blob/HEAD/packages/skills-catalog/catalog/bundled/software-development/github-pr-workflow/SKILL.md",
      "key": "paperclipai/paperclip/packages/skills-catalog/catalog/bundled/software-development/github-pr-workflow/SKILL.md"
    }
  },
  "instructions": "# GitHub Pull Request Workflow\n\nShip 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.\n\n## When to use\n\n- You are about to open a PR for a change that is functionally complete.\n- A reviewer left comments and you need to respond and push fixes.\n- A PR has been open more than a day and needs to be brought back into shape (stale conflicts, missing description, missing verification).\n\n## When not to use\n\n- The change is not yet functionally complete. Finish the work fir",
  "cost": {
    "context_tokens": 895
  }
}

Fetch it by URL: GET /api/v1/registry/paperclipai-paperclip-github-pr-workflow/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.