pr-description

Generate PR descriptions from frontmatter-driven repository templates.

29|17|Updated Feb 11, 2022

Search Tags:#automation #template #documentation #GitHub #generate #pull-request

Ready to run

npx skills add https://github.com/Sage-Bionetworks/sage-monorepo --skill pr-description-sage-bionetworks

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/Sage-Bionetworks/sage-monorepo/tree/main/.claude/skills/pr-description
Command: npx skills add https://github.com/Sage-Bionetworks/sage-monorepo --skill pr-description-sage-bionetworks

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Pull request descriptions are often time-consuming to craft and may miss critical details. This skill automates generation of comprehensive, template-compliant PR descriptions to ensure consistency and clarity across PRs.

Core Features & Use Cases

Template-aligned PR descriptions: Generates text that conforms to repository PR template standards.
Change summary & rationale: Includes a concise summary of changes and the motivation behind them.
Related issues & targets: Automatically references related Jira/GitHub issues and the target branch.
Use Case: When opening a new PR, updating an existing one, or documenting a complex code change, this skill can produce a complete description ready to paste.

Quick Start

Use this skill to generate a PR description for a feature or bug fix. Provide the changes summary, affected files, and any related issues or tickets, plus the target branch.

Frequently Asked Questions about pr-description

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

FAQPage Schema

How do I generate a GitHub pull request description from a template automatically?▼

Generate a GitHub pull request description by supplying the changes summary, affected files, related issues, and target branch. The skill outputs template-compliant text that includes the change rationale and impacted files, ready to paste into a new or updated PR.

What should a PR description include to meet repository documentation standards?▼

A PR description should include a concise changes summary, the rationale behind the modifications, impacted files, related GitHub or Jira issues, and the target branch. This ensures the pull request meets repository documentation and template standards.

Can I update an existing pull request description with newly documented code changes?▼

Yes, you can update an existing pull request description by providing the active code changes. The skill regenerates the PR text to reflect the new summary, rationale, and impacted files while maintaining the repository's frontmatter-driven template structure.

Do I need to provide related Jira issues and target branch details for PR generation?▼

Yes, providing related Jira or GitHub issues and the target branch is required. The skill uses these inputs alongside the changes summary and affected files to automatically reference them in the final generated pull request description.

What is the best way to automate pull request documentation for complex software projects?▼

Automate pull request documentation by using a frontmatter-driven template approach. This method standardizes PR descriptions across software projects by consistently structuring the changes summary, rationale, impacted files, and related issues into a clear, ready-to-paste format.