pr-description-generator

Generate structured PR descriptions from code diffs and commits.

2|Updated Jun 3, 2021

Search Tags:#automation #template #documentation #diff #pr #description #code-review

Ready to run

npx skills add https://github.com/kalindudc/shell --skill pr-description-generator-kalindudc

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pr-description-generator
Source: https://github.com/kalindudc/shell/tree/main/home/.config/opencode/skills/pr-description-generator
Command: npx skills add https://github.com/kalindudc/shell --skill pr-description-generator-kalindudc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing PR descriptions is time-consuming and inconsistent, making reviews harder and slowing merges.

Core Features & Use Cases

Structured PR templates that enforce a consistent Summary, Why, What, and Review Guidance.
Diff-aware context that references changed files and commits to ground the description in code changes.
Brevity-first guidance to keep descriptions readable within typical review time.

Quick Start

Generate a structured PR description for the current changes using the provided template.

Frequently Asked Questions about pr-description-generator

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

FAQPage Schema

How do I generate a structured PR description from code diffs and commits?▼

To generate a structured PR description from code diffs, the skill analyzes your repository changes and commits, then automatically fills a strict template with Summary, Why, What, and Review Guidance sections grounded in the actual code modifications.

What is the best way to automate PR description creation for code review?▼

The best way to automate PR description creation is using diff-aware templates that reference changed files and commits directly, enforcing consistent structure and brevity to maximize reviewability and speed up the merge process.

Can I use a PR template for feature branches, bug fixes, and refactors?▼

Yes, you can use this PR template for feature branches, bug fixes, and refactors. It adapts to various software development workflows by grounding the generated description in the specific diff and commit context of the current changes.

How do I include a changed files tree in my pull request documentation?▼

To include a changed files tree in your pull request documentation, the skill automatically maps the diff structure and integrates it into the strict PR template alongside technical details, keeping the description aligned with actual code changes.

Why are my PR descriptions inconsistent and hard to review?▼

PR descriptions are often inconsistent and hard to review because they lack a strict template. Enforcing structured sections like Summary, Why, What, and Review Guidance with diff-aware context ensures brevity and alignment with actual changes.

Does automated PR generation work without adding external dependencies?▼

Yes, automated PR generation works without external dependencies. The skill operates independently to analyze code changes and commits, enforcing a strict template to produce clear, structured descriptions directly from the diff context.