pr-conventions

Write pull request descriptions matching the user's preferred narrative style.

10|2|Updated Oct 3, 2020

Search Tags:#narrative #tone #conventions #pr #description #code-review #pull-request

Ready to run

npx skills add https://github.com/Gelio/dotfiles --skill pr-conventions-gelio

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pr-conventions
Source: https://github.com/Gelio/dotfiles/tree/main/universal/claude/skills/pr-conventions
Command: npx skills add https://github.com/Gelio/dotfiles --skill pr-conventions-gelio

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write PR descriptions matching the user's preferred style. Use when creating a pull request, drafting a PR description, or when the user says "write a PR description", "create PR", "/pr-conventions". Layers on top of any project-level PR skills (e.g., edb-git-conventions:pr).

Core Features & Use Cases

Narrative-driven PR descriptions that align with the target tone and formatting.
Precedence handling when combined with project-level PR conventions to ensure consistent results.
Context-aware guidance that explains what was added and how, while avoiding unnecessary boilerplate.

Quick Start

Draft a PR description in the user's preferred style.

Frequently Asked Questions about pr-conventions

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

FAQPage Schema

How do I write a PR description that matches my team's narrative style?▼

You can generate a PR description that matches your preferred style by applying narrative-driven conventions. The skill enforces the target tone and formatting sections while explaining key design decisions inline.

Can I generate pull request descriptions that follow specific formatting conventions?▼

Yes, you can generate pull request descriptions that follow specific formatting conventions. The skill layers on top of project-level PR conventions to ensure the output respects your predefined narrative sections and tone.

Does this work with existing project-level PR conventions?▼

Yes, this works with existing project-level PR conventions. It layers on top of project-level PR skills, handling precedence to ensure the generated descriptions align with both your personal style and project rules.

What is the best way to automate code review descriptions for design decisions?▼

The best way to automate code review descriptions for design decisions is to use a narrative-driven PR generator. It contextually explains what was added and how, avoiding unnecessary boilerplate while detailing key decisions inline.

How do I avoid boilerplate when drafting a PR description?▼

To avoid boilerplate when drafting a PR description, use context-aware generation that enforces your narrative style. It focuses on explaining what was added and how, ensuring the text remains relevant and concise.