skills.rest
sanity-io
sanity-ioOFFICIAL
Explore all skills by this author →
Website𝕏@sanity_ioGitHub

pr-description

Generate GitHub PR descriptions and release notes from commit history.

6.3k|548|Updated Jan 18, 2017
Search Tags:#automation#git#pr#description#pull-request#release-notes
One-click install
npx skills add https://github.com/sanity-io/sanity --skill pr-description-sanity-io
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/sanity-io/sanity/tree/main/.agents/skills/pr-description
Command: npx skills add https://github.com/sanity-io/sanity --skill pr-description-sanity-io

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing PR descriptions and release notes is time-consuming and inconsistent across teams; manual drafting often omits context, review guidance, or testing details, leading to slower reviews and less transparent releases.

Core Features & Use Cases

  • Generates PR descriptions aligned with the repository's PR template (Description, What to review, Testing, Notes for release).
  • Enforces drafting PRs and standardizes language and sections to improve reviewer efficiency.
  • Auto-generates release notes drafts from the commit history and PR metadata for streamlined disclosures.

Quick Start

Create a PR with gh pr create and have the tool populate the description automatically.

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I automate PR descriptions for GitHub pull requests?▼

You can automate PR descriptions by using this Skill to populate the description automatically when running gh pr create. It drafts structured content aligned with your repo's PR template, including sections for Description, What to review, Testing, and Notes for release.

How do I generate release notes from pull request metadata?▼

Generating release notes is done by automatically drafting them from commit history and PR metadata. This standardizes the disclosures for your releases and ensures that testing details and review guidance are consistently captured.

How do I standardize PR templates across a monorepo workflow?▼

Standardizing PR templates across a monorepo workflow involves enforcing structured sections like Description, What to review, Testing, and Notes for release. This ensures consistent language and drafting across all pull requests to improve reviewer efficiency.

Does this PR description automation work with draft PRs?▼

Yes, this PR description automation enforces drafting PRs to help standardize the write-up process. It prompts for specific sections like Description and Testing to ensure all necessary context is provided before the PR is marked as ready for review.

Why should I use automated pull request descriptions instead of manual drafting?▼

Automated pull request descriptions solve the inconsistency and time-consuming nature of manual drafting. By aligning with your repository's PR template and prompting for review guidance and testing details, it leads to faster reviews and more transparent releases.

Related Skills

Explore More Software Engineering Skills→
pipecat-aipipecat-ai
14.0k

pr-description

Generate concise GitHub PR descriptions from commits and diffs.

Official
Intermediate
drvossdrvoss
42

release

Automates version tagging, changelog generation, GitHub Releases, and artifact publishing to registries.

Community
Advanced
gagan114662gagan114662

github

Manage GitHub repositories, pull requests, issues, and Actions workflows via gh CLI and APIs.

Community
Intermediate
NITRR-OfficialNITRR-Official
4

pr-description-generator

Generate pull request titles and descriptions from commit history.

Official
Intermediate