writing-pr-descriptions

Generate PR descriptions following project voice rules and workflow conventions.

24|3|Updated Aug 2, 2020
One-click install
npx skills add https://github.com/ooloth/dotfiles --skill writing-pr-descriptions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-pr-descriptions
Source: https://github.com/ooloth/dotfiles/tree/main/tools/claude/config/skills/writing-pr-descriptions
Command: npx skills add https://github.com/ooloth/dotfiles --skill writing-pr-descriptions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides voice rules, templates, and workflow guidance to create consistent PR descriptions that communicate user impact and validation steps.

Core Features & Use Cases

  • Voice guidelines: Framework for tone, audience, and brevity.
  • Templates: Starter structures for common PR types and validation steps.
  • Workflow: Guidance on how to compose and validate PR bodies before submission.

Quick Start

Invoke this skill to draft PR descriptions by providing changes and context; Claude will produce a concise, user-centric body following the rules.

Frequently Asked Questions about writing-pr-descriptions

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

FAQPage Schema
How do I write PR descriptions that match my project's voice and style?

PR descriptions should follow your project's voice rules for tone and brevity. This skill generates descriptions that adhere to your project's conventions, sourcing your PR template and embedding guidance on audience, anti-patterns, and workflow to ensure consistency across all contributions.

What should a PR description include to communicate user impact?

Effective PR descriptions combine what changed, why it matters to users, and validation steps. This skill drafts sectioned bodies that highlight user impact, include screen-recording references or links to Jira/Slack, and outline how to validate the changes before submission.

Can I use templates to speed up writing PR descriptions?

Yes. This skill provides starter templates for common PR types and validation workflows. Templates establish consistent structure across your project while the skill generates descriptions tailored to your specific changes and voice guidelines.

How do I avoid common mistakes in PR descriptions?

Anti-pattern guidance built into this skill highlights what not to do—vague impact claims, missing validation steps, or tone misalignment. It generates descriptions that steer clear of these pitfalls while conforming to your project's workflow conventions.

Does this work with gh CLI and existing PRs?

Yes. This skill applies to PR creation via gh CLI and editing existing pull requests. It gathers your changes and drafts descriptions that fit your project's workflow, whether you're composing new PRs or refining submitted ones.