skills.rest
adschill
adschillCOMMUNITY
Explore all skills by this author →
GitHub

pr-description-summary

Generates a concise bullet-list pull request description from the current branch diff.

Updated Feb 26, 2025
Search Tags:#code review#markdown#pull request#github#git diff#pr description#branch summary
One-click install
npx skills add https://github.com/adschill/dev-config --skill pr-description-summary-adschill
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description-summary
Source: https://github.com/adschill/dev-config/tree/main/skills/pr-description-summary
Command: npx skills add https://github.com/adschill/dev-config --skill pr-description-summary-adschill

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing pull request descriptions by hand is repetitive, and reviewers often receive vague or overly detailed summaries. This Skill inspects the current branch's diff and produces a succinct, reviewer-friendly bullet list that captures what actually changed. ## Core Features & Use Cases - Diff-Based Summarization: Inspects the changed file list and diff against the base branch before drafting, grouping related edits into user-facing themes. - Structured Output Contract: Returns 3 to 7 copyable Markdown bullets starting with strong verbs like Adds, Fixes, or Refactors, with no headings or filler. - Noise Filtering: Omits low-signal changes such as formatting-only edits or renames without behavior impact, and handles thin diffs honestly. - Use Case: Before opening a pull request, ask for a branch summary and paste the resulting bullets directly into the PR description field on GitHub. ## Quick Start Ask the assistant to draft a succinct bullet-list PR description for the current branch compared to the main branch.

Frequently Asked Questions about pr-description-summary

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

FAQPage Schema
How do I generate a pull request description from my branch diff?▼

Invoke the skill on your current branch and it inspects the changed files and diff against the base branch, then returns a copyable Markdown bullet list. The output uses 3 to 7 bullets starting with verbs like Adds, Fixes, or Refactors.

How to summarize git changes for code review?▼

The skill groups related edits into user-facing themes rather than restating file-by-file churn. It highlights behavior changes, new capabilities, bug fixes, and test updates while omitting formatting noise and renames without behavior impact.

Which base branch does the PR summary compare against?▼

It prefers an explicit base you provide, then the PR base branch, then the repository default branch or upstream tracking branch. You can override the comparison target by stating the base branch in your request.

What happens if my branch has almost no changes?▼

If the branch contains little or no meaningful diff, the skill says so plainly in a single bullet instead of inventing detail. This keeps PR descriptions honest for trivial or empty branches.

Can I customize the PR description output format?▼

By default the output is a bullet list only, with no headings, preambles, or code blocks. You can explicitly ask for additional structure such as headings or fenced blocks, and the skill will include them on request.

Related Skills

Explore More Software Engineering Skills→
oElberteoElberte

create-pr

Create a GitHub pull request with a Conventional Commits title and templated body.

Community
Intermediate
likec4likec4
5.6k

likec4-gh-pr-triage

Inspect GitHub PR status, review comments, and issue mentions using the gh CLI.

Official
Intermediate
erfanzarerfanzar
27

requesting-code-review

Automate pre-commit code review with static checks, linting, and auto-fixes.

Community
Advanced
wsmanwsman
18

patch-notes

Generate categorized release notes from changelogs and git history.

Community
Advanced