pr-scribe

Draft GitHub pull request bodies with brand-aware structure and data sourcing.

Updated May 3, 2024
One-click install
npx skills add https://github.com/Kyonax/dot-files --skill pr-scribe-kyonax
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-scribe
Source: https://github.com/Kyonax/dot-files/tree/main/.config/doom-mac/gptel-directives/skills/pr-scribe
Command: npx skills add https://github.com/Kyonax/dot-files --skill pr-scribe-kyonax

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Different GitHub organizations follow wildly different pull request conventions — from checklist items and Changes block formats to data sourcing habits and QA section wording. Applying the wrong brand's format produces PRs that fail local review, while manually adapting each PR wastes maintainer time and introduces inconsistency.

Core Features & Use Cases

  • Auto-brand detection: Identifies the target brand (Madison Reed, Kyonax, or generic fallback) from the git remote URL or user override, then loads the exact format and data-source conventions for that brand.
  • Brand-aware PR generation: Drafts complete PR bodies with the correct checklist items, Changes pattern (flat list vs themed subsections), Technical Details variant, Testing Coverage layout, QA heading wording, and Documentation vocabulary.
  • Validation and maintenance: Validates existing PR text against brand rules and helps onboard new brands by capturing conventions into reusable rule files.

Quick Start

Use the pr-scribe skill to draft a pull request body for the current repository by simply asking it to write the PR description, and it will automatically detect the brand and apply the correct conventions.

Frequently Asked Questions about pr-scribe

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

FAQPage Schema
How do I automatically draft a pull request body that matches my GitHub organization's conventions?

To draft a pull request body that matches GitHub organization conventions, use the skill to automatically detect the brand from the git remote URL and apply the correct checklist items, Changes pattern, and QA wording.

Can I validate existing PR text against specific code review conventions?

Yes, you can validate existing pull request text against code review conventions by checking the content for absolute URLs, restricted emojis, and references to private files to ensure compliance before merging.

Do I need the gh CLI tool to generate brand-aware PR descriptions?

Yes, you need both git and gh CLI tools to generate brand-aware PR descriptions, as the skill requires them to detect the repository context and enforce cross-cutting writing disciplines.

What is the best way to onboard new pull request formatting rules for a different GitHub brand?

The best way to onboard new pull request formatting rules is to use the skill to capture the specific organizational conventions into reusable rule files for future PR drafting.

Why do my pull request drafts fail local code review across different GitHub organizations?

Pull request drafts fail local code review when they apply the wrong brand's format, such as incorrect Changes block patterns or QA heading wording, instead of the specific conventions required by the target GitHub organization.