describing-PRs

Generate a Markdown PR draft from branch changes for magit-forge workflows.

15|2|Updated Aug 16, 2025
One-click install
npx skills add https://github.com/aspiers/ai-config --skill describing-prs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: describing-PRs
Source: https://github.com/aspiers/ai-config/tree/main/.claude/skills/describing-PRs
Command: npx skills add https://github.com/aspiers/ai-config --skill describing-prs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Generate a well-structured PR description for the current feature branch.

Core Features & Use Cases

  • Analyze the current branch against its base to surface context and intent.
  • Compile a concise Title, Summary, Changes, Testing, and Notes into a Markdown PR draft placed at .git/magit/posts/new-pullreq.
  • Integrates with magit-forge workflows and supports multiple remotes to identify the correct base branch.

Quick Start

Run the PR description generator in your repository to create the new PR draft file for the current branch.

Frequently Asked Questions about describing-PRs

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

FAQPage Schema
How do I auto-generate a pull request description for my current Git branch?

You can auto-generate a pull request description by analyzing the current branch against its base to compile a Markdown draft with Title, Summary, Changes, Testing, and Notes sections.

How does a PR description generator determine the correct base branch in a multi-remote context?

The PR description generator supports multiple remotes to correctly identify the base branch, ensuring the compiled Markdown draft accurately reflects the branch context and intended changes.

Can I use this to create a Markdown PR draft that integrates with magit-forge workflows?

Yes, you can create a Markdown PR draft that integrates with magit-forge workflows by persisting the generated description directly to the `.git/magit/posts/new-pullreq` file path.

What is the best way to summarize Git commits into a structured PR template?

The best way to summarize Git commits into a structured PR template is to gather commit context and analyze changes, automatically formatting them into a consistent Markdown narrative.

Do I need to manually edit the generated PR description file before submitting my pull request?

You may need to manually review the generated PR description file, as the tool compiles commit context and changes into a draft format that you can edit before final submission.