pr-description-skill

To generate a markdown PR body, this Skill composes TL;DR, WHY, WHAT, and HOW sections into a single document. It enforces strict structure, line count targets, and validation rules to produce an evidence-backed artifact suitable for gh pr create --body-file.

The best way to create an evidence-backed pull request description is using verbatim anchors linked to canonical sources. This Skill generates a deterministic PR body that improves traceability and auditability by grounding claims in trusted documentation and validation output.

Yes, you can use this PR description generator with gh pr create --body-file. The output is a self-contained Markdown document designed to be directly consumed by the GitHub CLI, including optional mermaid diagrams and a fixed How-to-test workflow section.

Mermaid diagram validation for PR bodies works by referencing conventions in assets/mermaid-conventions.md. The Skill enforces strict structural constraints and validates diagrams to ensure PR bodies remain scannable and correctly illustrate non-trivial changes.

A limitation of using a fixed validation rubric for PR descriptions is reduced flexibility. The Skill enforces a strict section order, line count targets, and encoding rules specifically optimized for microsoft/apm, which may not suit repositories requiring unconventional PR body formats.