skills.rest
githubnext
githubnextOFFICIAL
Explore all skills by this author →
Website𝕏@githubnextGitHub

pr-description-skill

Generate a structured PR description markdown with evidence and diagrams.

4|1|Updated May 7, 2026
Search Tags:#markdown#pull request#diagram validation#pr description#validation evidence
One-click install
npx skills add https://github.com/githubnext/apm --skill pr-description-skill-githubnext
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description-skill
Source: https://github.com/githubnext/apm/tree/main/.apm/skills/pr-description-skill
Command: npx skills add https://github.com/githubnext/apm --skill pr-description-skill-githubnext

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines the process of writing a PR description by providing a template that includes all necessary sections and elements, such as TL;DR, Problem, Approach, Implementation, Diagrams, Trade-offs, Benefits, Validation, and How to Test.

Core Features & Use Cases

  • Structured PR Description: Generates a PR description that covers all necessary aspects.
  • Anchor Quotations: Includes verbatim quotes for each claim in the PR.
  • Diagram Validation: Ensures all diagrams are valid and correctly render.
  • Scenario Evidence: Maps user promises to tests proving the PR works.
  • Use Case: When preparing a PR for a pull request, this Skill can help draft a comprehensive and validated PR description that clearly communicates the changes and reasoning.

Quick Start

Run the skill with the necessary input details, such as branch name, base ref, files changed, commit messages, CHANGELOG entry, linked issue, and validation evidence.

Frequently Asked Questions about pr-description-skill

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

FAQPage Schema
How do I generate a structured pull request description with validation evidence?▼

You can generate a structured PR description by supplying branch name, base ref, changed files, commit messages, CHANGELOG entry, linked issue, and validation evidence to output a markdown file with TL;DR, approach, diagrams, and testing sections.

What is the best way to include anchor quotations and diagrams in a PR description?▼

The best way to include anchor quotations and diagrams in a PR description is to use a template that inserts verbatim quotes for each claim and performs diagram validation to ensure correct rendering in the markdown output.

How do I map user scenarios to test evidence when writing a PR description?▼

Map user scenarios to test evidence by adding scenario evidence sections to the PR description, linking user promises to specific validation tests that prove the pull request works as intended.

Do I need linked issues and CHANGELOG entries to create a validated PR description?▼

You need linked issues and CHANGELOG entries to create a validated PR description, as these inputs provide the context and validation evidence required to generate the complete markdown output.

What sections are included in a structured markdown PR description?▼

A structured markdown PR description includes sections for TL;DR, Problem, Approach, Implementation, Diagrams, Trade-offs, Benefits, Validation, and How to Test, covering all necessary aspects of the pull request changes.

Related Skills

Explore More Software Engineering Skills→
alirezarezvanialirezarezvani
763

git-commit-helper

Generate conventional commit messages from staged git diff changes.

Community
Basic
assertchrisassertchris
2

custom-submit-pr

Create a GitHub pull request with the gh CLI and assign it to assertchris.

Community
Intermediate
lance-doniflance-donif

data-model-creation

Generate Mermaid class diagrams for visual data relationship modeling.

Community
Advanced
a-taka-tak
1

git-create-pr

Commit changes, push to origin, and create a GitHub Pull Request.

Community
Intermediate