create-pr

Name: create-pr
Availability: InStock
Author: citybear3

Generate GitHub pull request descriptions from git diffs and commit history.

Updated Nov 4, 2022

Search Tags:#code review #pull request #github #release notes #git diff #design decisions #documentation drafting

Ready to run

npx skills add https://github.com/CityBear3/dotfiles --skill create-pr-citybear3

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: create-pr
Source: https://github.com/CityBear3/dotfiles/tree/main/claude/skills/create-pr
Command: npx skills add https://github.com/CityBear3/dotfiles --skill create-pr-citybear3

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates the time-consuming work of writing consistent, reviewer-friendly GitHub pull request descriptions from your branch’s commits and diff.

Core Features & Use Cases

Automatically drafts fact-based sections (e.g., summary, changes, and test plan items) from git status, git log, and git diff.
Guides intent-based writing safely by requiring the engineer to provide Design Decisions and other rationale, or by linking to an existing Design Doc / lifting approved plan decisions.
Respects repository PR templates by detecting the first available template and using its sections verbatim.

Quick Start

Run the skill with /create-pr to generate a PR description for the current branch, defaulting the base branch to main.

Frequently Asked Questions about create-pr

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automatically generate a GitHub pull request description from git diff and commit history?▼

To generate a GitHub pull request description from git diff and commit history, this skill extracts fact-based sections from git status, git log, and git diff. It structures the repository changes into a review-ready format while respecting your existing PR template sections verbatim.

What is the best way to draft a review-ready GitHub PR without missing design decisions?▼

Drafting a review-ready GitHub PR safely requires separating automated facts from engineer-authored rationale. This skill prevents fabricated intent by extracting diff facts automatically while guiding you to provide or link design decisions and trade-offs before creation.

Can I use my repository's existing PR template to structure pull request descriptions?▼

Yes, you can use your repository's existing PR template to structure pull request descriptions. The skill detects the first available template within your repository and uses its sections verbatim to ensure the generated output matches your team's required documentation format.

Does the create-pr skill abort if there are uncommitted changes in my git working directory?▼

Yes, the skill aborts if there are uncommitted changes in your git working directory. This safety mechanism ensures that the generated pull request description relies entirely on committed git diff and git log evidence rather than incomplete or unstaged code modifications.

How do I ensure my pull request documentation includes rationale for design trade-offs?▼

To ensure pull request documentation includes rationale for design trade-offs, the skill requires engineers to complete placeholders for design decisions. It prevents PR creation until you provide the necessary intent-based rationale or link to an approved design document.