format-github-pr

Format GitHub pull request titles and descriptions with context and before/after sections.

Updated Jun 4, 2025

Search Tags:#documentation #github #formatting #pr #code-review #pull-request

Ready to run

npx skills add https://github.com/alexei-lexx/budget --skill format-github-pr

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: format-github-pr
Source: https://github.com/alexei-lexx/budget/tree/main/.claude/skills/format-github-pr
Command: npx skills add https://github.com/alexei-lexx/budget --skill format-github-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Format a GitHub pull request title and description to communicate changes and rationale clearly, reducing review cycles and confusion.

Core Features & Use Cases

Generate concise, well-structured PR titles suitable for gh pr create / gh pr edit.
Produce a user-facing description with context, before, and after sections to explain the change impact.
Adapt formatting for bug fixes, features, and docs updates across multiple branches and collaborators.

Quick Start

Format a PR title and description for the upcoming changes.

Frequently Asked Questions about format-github-pr

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

FAQPage Schema

How do I format a GitHub pull request title and description for code review?▼

Format a GitHub pull request title and description by applying a structured layout with context, before, and after sections. This ensures your PR clearly communicates what changed and why, reducing review cycles and confusion.

What is the best way to structure a PR description for bug fixes and feature work?▼

The best way to structure a PR description for bug fixes and feature work is to use a consistent format with dedicated context, before, and after sections. This clearly explains the change impact and rationale across multiple branches.

Can I use a formatted PR title directly with gh pr create and gh pr edit?▼

Yes, you can use the generated PR titles and descriptions directly with gh pr create and gh pr edit. The formatting produces concise, well-structured text suitable for these commands to update or create pull requests.

Does a consistent PR format help with documentation changes across multiple collaborators?▼

A consistent PR format helps with documentation changes across multiple collaborators by adapting the structure and tone for docs updates. This ensures every team member clearly understands the context and impact of the modifications.

How do I write a concise before and after narrative for a pull request?▼

Write a concise before and after narrative for a pull request by populating structured description sections. This produces a polished title and a clear narrative explaining the state prior to the change and the resulting outcome.