pr-description

Write PR titles, bodies, and commit messages from git branch diffs.

Updated Apr 3, 2021
One-click install
npx skills add https://github.com/shrik450/dotfiles --skill pr-description-shrik450
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/shrik450/dotfiles/tree/main/dot_claude/skills/pr-description
Command: npx skills add https://github.com/shrik450/dotfiles --skill pr-description-shrik450

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing clear, consistent PR descriptions and commit messages takes time, and generic templates often produce boilerplate that reviewers ignore. This Skill analyzes your branch's commits and diff to draft a PR title and body that match your personal writing style. ## Core Features & Use Cases - Branch-aware drafting: Reads git log and git diff against main to understand what actually changed before writing anything. - Style-matched output: Follows concrete style rules and real examples—imperative titles under 70 characters, casual direct prose, no template headers or file inventories. - Existing PR awareness: If the branch already has a PR, it pulls the current title and body via gh pr view and preserves useful context instead of overwriting blindly. - Use Case: You finished a multi-commit bug fix branch and need a PR description. The Skill reviews the commits, explains the root cause and fix in plain prose, includes the ticket ID in the title, and calls out any incidental fixes separately. ## Quick Start Ask the assistant to write a PR description for the current branch's changes against main.

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I write a good PR description from my branch changes?

Review all commits with git log main..HEAD and the full diff with git diff main, then lead the body with the problem or motivation in one or two sentences. Use short lists only for multiple substantive fixes, and call out incidental bug fixes separately from the main change.

How to include a ticket ID in a PR title automatically?

Scan the branch's commit messages for a ticket pattern like [ID-XXXX] and prefix the title with it, followed by a short imperative description. Keep the full title under 70 characters and avoid conventional commit prefixes like feat:.

Can this update an existing pull request description?

Yes, it runs gh pr view --json title,body,isDraft,url to fetch the existing PR and treats its description and draft status as source material. Useful context is preserved unless you explicitly ask for a full rewrite.

What should a PR description avoid including?

Avoid template headers like Summary, Changes, or Test plan, bullet lists of files changed, emojis, and verbose descriptions of obvious things. Write like you are explaining the change to a colleague rather than filling out a form.

Does this create the pull request on GitHub?

No, it only drafts the title and body text. The PR is created only if you explicitly ask for it, keeping the default behavior limited to writing the description content.