describing-pr

Generate structured Pull Request descriptions from Git diffs and commit history.

1|Updated Jan 31, 2026
One-click install
npx skills add https://github.com/jugrajsingh/skillgarden --skill describing-pr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: describing-pr
Source: https://github.com/jugrajsingh/skillgarden/tree/main/plugins/shipit/skills/describing-pr
Command: npx skills add https://github.com/jugrajsingh/skillgarden --skill describing-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive Pull Request descriptions by analyzing code changes, commit history, and project plans, ensuring clarity and consistency in your development workflow.

Core Features & Use Cases

  • Automated Description Generation: Creates titles, summaries, detailed changes, test plans, and breaking change sections.
  • Contextual Analysis: Leverages Git logs, diffs, task plans, and commit messages for rich descriptions.
  • Use Case: After completing a new feature, run this Skill to automatically draft a PR description that includes what changed, why it changed, how to test it, and any potential breaking changes, ready for review.

Quick Start

Use the describing-pr skill to generate a pull request description for the current branch.

Frequently Asked Questions about describing-pr

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

FAQPage Schema
How do I automatically generate a PR description from Git diffs and commit history?

You can generate a structured Pull Request description by analyzing Git diffs, commit history, and task plans to automatically identify changes, outline test plans, and flag breaking changes for code review.

Can I create PR descriptions with test plans based on acceptance criteria?

Yes, PR description generation outlines test plans based on acceptance criteria by leveraging project documentation and commit messages to ensure the description includes how to test the changes.

Do I need Git CLI and GitHub CLI to generate PR descriptions from code?

Yes, generating structured PR descriptions requires Git CLI and GitHub CLI, along with access to project documentation, to provide comprehensive context for analyzing code changes.

What is the best way to draft PR descriptions that flag breaking changes for software engineering teams?

The best way to draft PR descriptions is to use contextual analysis of Git logs, diffs, and task plans to automatically identify what changed, why it changed, and flag breaking changes for review.

How does analyzing conventional commits improve PR description generation?

Analyzing conventional commits and Git logs provides rich contextual analysis that allows the PR description generation to accurately summarize detailed changes and create structured titles.

When should I not use automated PR description generation for my development workflow?

Automated PR description generation is not suitable when you lack access to project documentation or do not have Git CLI and GitHub CLI configured, as comprehensive context is required for accurate descriptions.