pr-description-chain-writer

Generate draft descriptions for ordered chains of GitHub PRs from commit/file data and a style reference PR.

1|Updated Apr 15, 2024

Search Tags:#automation #workflow #template #github #style-guide #pr-description #pr-chain

Ready to run

npx skills add https://github.com/yiminllin/dotfiles --skill pr-description-chain-writer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pr-description-chain-writer
Source: https://github.com/yiminllin/dotfiles/tree/main/opencode/.config/opencode/skills/pr-description-chain-writer
Command: npx skills add https://github.com/yiminllin/dotfiles --skill pr-description-chain-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This skill automates the creation of draft PR descriptions for ordered PR chains by reusing a style reference PR and enforcing a consistent template across all PRs in the sequence.

Core Features & Use Cases

Reuses the structure and tone from a style reference PR to maintain consistency across stacked PRs.
Generates the "Reason for Change" and "Description of Change" blocks with a hybrid prose-plus-bullets format, plus built-in nonfunctional and release-note defaults.
Automatically renders a compact "Verification" block (Unit Test, Manual Test, CI) and includes a PR Tree for multi-PR chains.

Quick Start

Provide ordered PR numbers to generate draft chain PR bodies.

Frequently Asked Questions about pr-description-chain-writer

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

FAQPage Schema

How do I generate consistent PR descriptions for a stacked GitHub PR chain?▼

Generate consistent PR descriptions for a stacked GitHub PR chain by providing ordered PR numbers to a script that reads commits and files, then formats each body using a style reference PR.

What is a style reference PR and how does it automate PR body formatting?▼

A style reference PR provides the existing structure and tone for the generator script to reuse, automating PR body formatting by enforcing a hybrid prose-plus-bullets template across all stacked PRs.

Can I override the default style guide when drafting GitHub PR descriptions?▼

You can override the default style guide when drafting GitHub PR descriptions by supplying a specific style-pr override to the generator script, ensuring the output matches your preferred template.

How do I visualize stacked GitHub PRs during chain description generation?▼

Visualize stacked GitHub PRs during chain description generation through an automatically rendered PR Tree, which maps the ordered sequence and provides a compact overview of the dependencies.

What sections are included in the automated GitHub PR description template?▼

The automated GitHub PR description template includes a Reason for Change block, a Description of Change with nested bullets, nonfunctional and release-note defaults, and a compact Verification block.

Do I need any dependencies to run the PR chain description generator script?▼

You do not need any dependencies to run the PR chain description generator script, as it operates standalone to read PR commits and files without requiring external libraries.