skills.rest
toqoz
toqozCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

pr-description

Generate structured GitHub pull request titles and descriptions with verification steps.

Updated Oct 15, 2021
Search Tags:#code review#documentation#pull request#github#technical writing
One-click install
npx skills add https://github.com/toqoz/config --skill pr-description-toqoz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/toqoz/config/tree/main/home/agents/skills/pr-description
Command: npx skills add https://github.com/toqoz/config --skill pr-description-toqoz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates the ambiguity and inconsistency in pull request documentation, ensuring that reviewers and maintainers can quickly understand the intent, impact, and verification of any code change.

Core Features & Use Cases

  • Contextual PR Drafting: Generates structured titles and bodies tailored to the specific type of change, such as UI updates, bug fixes, or infrastructure refactors.
  • Evidence-Based Documentation: Guides the user to include necessary verification steps, screenshots, and design references to build reviewer trust.
  • Use Case: When submitting a complex UI change, use this skill to generate a summary that highlights the visual impact, links to the relevant Figma design, and lists the specific browser states verified.

Quick Start

Use the pr-description skill to draft a pull request body for the current feature branch that summarizes the new user-facing behavior and includes the required verification steps.

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I write a GitHub pull request description for reviewers?▼

To write a GitHub pull request description, use structured templates that clearly separate the change intent, impact, and verification steps. This standardizes documentation so reviewers can quickly understand the context and scope of the code change.

What should be included in a pull request body for a complex UI change?▼

A pull request body for a complex UI change should include a summary of the visual impact, links to design references like Figma, and specific browser states verified. Providing this evidence-based documentation builds trust with reviewers.

Can I use a standard PR template for different types of code review submissions?▼

Yes, you can use a standard PR template for different code review submissions. It applies structural formatting and evidence-based documentation principles to all PR types, including UI updates, bug fixes, refactors, and infrastructure updates.

What is the best way to document bug fixes in a pull request title and body?▼

The best way to document bug fixes in a pull request is to standardize the title and body using specific structural templates. This ensures the intent, impact, and verification of the fix are clearly communicated for future maintainers.

Does standardizing technical writing for pull requests improve code review efficiency?▼

Standardizing technical writing for pull requests improves code review efficiency by eliminating ambiguity and inconsistency. It ensures reviewers and maintainers can quickly understand the intent, impact, and verification of any code change.

Related Skills

Explore More Software Engineering Skills→
v1-iov1-io
6

pr-description

Generate PR descriptions from git diff and commit history.

Official
Intermediate
SuperCorksSuperCorks

address-pr-comments

Fetch GitHub PR reviews via gh CLI and apply latest reviewer feedback.

Community
Advanced
xxihxxih
1

springboot-verification

Validate Spring Boot applications with build, static analysis, coverage, and security scans.

Community
Advanced
richardnpaulrichardnpaul

coding-standards

Standardizes coding practices for TypeScript, JavaScript, React, and Node.js projects.

Community
Advanced