pr-description

Generate and update GitHub pull request descriptions from git diffs using gh CLI.

49|11|Updated Jul 31, 2026
One-click install
npx skills add https://github.com/vstorm-co/agenticos --skill pr-description-vstorm-co
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/vstorm-co/agenticos/tree/main/.claude/skills/pr-description
Command: npx skills add https://github.com/vstorm-co/agenticos --skill pr-description-vstorm-co

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, informative pull request descriptions is repetitive and often skipped, leaving reviewers without context on what changed, why, and how to verify it. ## Core Features & Use Cases - Diff-Based Description Generation: Builds a structured PR body (Summary, Business Context, Changes, Architecture, Verification, Linked Issues) from git diff and commit history against the detected default branch. - Create or Update PRs: Creates new PRs with gh pr create or merges updates into existing PR bodies with gh pr edit, preserving hand-written content the diff cannot reconstruct. - Architecture Diagrams and Trace Evidence: Embeds mermaid diagrams for architectural changes and links real observability evidence in the Verification section when the repo has a tracing backend. - Use Case: After finishing a feature branch, ask the agent to open a PR; it fetches the base branch, analyzes the diff, writes a consistent description, and returns the PR URL. ## Quick Start Ask the agent to create a pull request for the current branch with a description generated from the diff against the default branch.

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I generate a PR description from a git diff?▼

Fetch the base branch, run git diff origin/BASE...HEAD and git log to gather changes, then format them into Summary, Changes, and Verification sections. The skill writes the body to a file and passes it to gh pr create with --body-file.

How to update an existing GitHub PR description with gh CLI?▼

Use gh pr view to read the current title and body, merge the existing hand-written content with new diff information, then apply the result with gh pr edit <pr-number> --body-file. This avoids silently replacing verification evidence and issue links.

Can I attach images or diagrams to a GitHub PR description?▼

The gh CLI has no image-upload flag, and local PNG paths render as broken images for reviewers. Instead, embed mermaid diagrams directly in the PR body, which GitHub renders natively in pull request descriptions.

Why does my PR diff show commits that were already merged?▼

The local remote-tracking ref is stale. Run git fetch origin for the base branch before diffing, since gh repo view returns only the branch name and does not update origin/BASE locally.

What sections should a good pull request description include?▼

Include a Summary, Business Context, technical Changes, Verification steps, and Linked Issues. Add an Architecture section with mermaid diagrams only for changes that reshape flows across components, and omit empty sections rather than leaving placeholders.