github-pr_skill

Overview

This skill helps you create high-quality GitHub Pull Requests with conventional commit titles, clear descriptions, and appropriate metadata. It guides PR creation via the gh CLI, templates PR bodies, and enforces atomic commits and useful review context. Use it to speed up PR authoring, improve reviewability, and link changes to issues.

How this skill works

The skill inspects your proposed commit messages and PR title and suggests a conventional-commit formatted title (type(scope): short description). It generates a structured PR description with Summary, Changes, Testing checkboxes, and issue-closing lines. It offers gh CLI command examples and patterns for draft PRs, reviewers, labels, and merge strategies like squash.

When to use it

• When creating a new Pull Request from local branches or the CLI
• When writing or improving a PR title and description
• When preparing commits to ensure they are atomic and scoped
• Before running gh pr create or gh pr edit to add reviewers/labels
• When splitting large work into smaller, reviewable PRs

Best practices

• Follow Conventional Commits for PR titles: type(scope): short description (feat, fix, docs, refactor, test, chore).
• Keep commits atomic: one logical change per commit with clear messages and tests where applicable.
• Use the PR description template: Summary, Changes, Testing, and Closes #issue to link work to issues.
• Avoid giant PRs—split by feature, API, model, UI where possible to simplify review.
• Include reviewers, labels, and CI status checks in the PR metadata; prefer draft PRs for in-progress work.

Example use cases

• Open a draft refactor: gh pr create --draft --title "wip: refactor auth" --body "Work in progress" for early feedback.
• Submit a small focused fix: commit as git commit -m "fix(session): prevent session timeout" then gh pr create with testing checklist.
• Create a rich PR body via HEREDOC for screenshots and long descriptions when using gh in scripts.
• Add reviewers and labels in one command: gh pr create --title "feat(api): add rate limiting" --body "..." --reviewer "alice,bob" --label "enhancement,api"