github-pull-request-description

Generate concise GitHub pull request descriptions with structured sections for features and fixes.

12.5k|757|Updated Jun 13, 2024
One-click install
npx skills add https://github.com/longbridge/gpui-component --skill github-pull-request-description-longbridge
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: github-pull-request-description
Source: https://github.com/longbridge/gpui-component/tree/main/.claude/skills/github-pull-request-description
Command: npx skills add https://github.com/longbridge/gpui-component --skill github-pull-request-description-longbridge

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

PR descriptions are often inconsistent and verbose, making reviews slower and harder to triage. This skill generates concise, targeted descriptions that communicate the essence of changes to maintainers and reviewers.

Core Features & Use Cases

  • Automated summaries: Produces a clear summary of added, modified, and removed changes from the diff.
  • Structured formatting: Includes sections for features, fixes, tests, and any breaking changes when applicable.
  • Review-ready output: Generates a PR description ready to paste into the GitHub PR body, with optional examples.

Quick Start

Provide a concise summary of the PR changes and intent.

Frequently Asked Questions about github-pull-request-description

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

FAQPage Schema
How do I generate a GitHub pull request description from a diff?

Generate a GitHub pull request description by providing a concise summary of your code changes and intent. The skill outputs a structured, review-ready PR body with a diff summary, feature and fix sections, and examples for immediate pasting.

What is the best way to format breaking changes in a PR description?

Formatting breaking changes in a PR description involves using a structured section to isolate impacts. The generated output explicitly separates breaking changes from features and fixes, ensuring reviewers immediately identify potential regressions without scanning verbose diffs.

Can I automate PR summaries for Rust project repositories?

You can automate PR summaries for Rust project repositories by processing the code diff. The skill applies a consistent, structured format to Rust projects and general software repositories, categorizing features, bug fixes, and breaking changes into a reviewer-friendly tone.

Does the generated PR description include a diff summary for code review?

The generated PR description includes a clear diff summary detailing added, modified, and removed changes. It enforces a consistent structure with specific sections for tests, features, and fixes to accelerate the code review and triage process.

How do I write reviewer-ready PR descriptions without manual formatting?

Write reviewer-ready PR descriptions by submitting your change summary to the automation skill. It eliminates manual formatting by producing a structured output with a diff summary and categorized sections, reducing verbosity and making code reviews faster to triage.