pr-summary

Generate a canonical PR description from a diff with rubric-aligned sections.

19|31|Updated May 29, 2025
One-click install
npx skills add https://github.com/grafana/grafana-pathfinder-app --skill pr-summary-grafana
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-summary
Source: https://github.com/grafana/grafana-pathfinder-app/tree/main/.cursor/skills/pr-summary
Command: npx skills add https://github.com/grafana/grafana-pathfinder-app --skill pr-summary-grafana

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Drafts a complete PR description from a code diff by surfacing the author’s motivation and tailoring the PR sections.

Core Features & Use Cases

  • Interviews the author to surface the motivation behind the change.
  • Generates canonical PR sections (Summary, What to look at, Why, How to verify, Breaking changes, Reversibility) aligned to the change type.
  • Produces a draft suitable for human review and can pair with /review; supports applying via gh pr edit after explicit confirmation.

Quick Start

Provide the diff you want described and let the skill generate a draft PR description for review.

Frequently Asked Questions about pr-summary

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

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

To generate a pull request description from a diff, provide the diff to the skill. It identifies the motivation behind the change and drafts canonical PR sections like Summary, Why, and How to verify for human review.

Can I automatically apply a drafted PR description using gh pr edit?

You can apply the drafted PR description using gh pr edit, but only after giving explicit confirmation. The skill produces a draft suitable for human review without applying changes automatically to ensure accuracy.

What sections should a pull request template include for a code review?

A PR template for a code review should include Summary, What to look at, Why, How to verify, Breaking changes, and Reversibility. These sections are tailored to the specific change type identified in the diff.

How do I document breaking changes and reversibility in a pull request?

To document breaking changes and reversibility in a pull request, the skill analyzes the diff and routes constraints from docs/design/CONCERNS.md. It then generates dedicated sections detailing these risks for the draft description.

Does the skill reference commit bodies and head SHA for file links in the PR draft?

Yes, the skill references the head SHA and remote URL for all file links in the PR draft. It also pulls commit bodies and PR context to accurately identify the motivation behind the diff.