pr-description

Writes structured pull request bodies for GitHub PRs in the insight repository.

10|9|Updated May 22, 2026
One-click install
npx skills add https://github.com/constructorfabric/insight --skill pr-description-constructorfabric
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/constructorfabric/insight/tree/main/.claude/skills/pr-description
Command: npx skills add https://github.com/constructorfabric/insight --skill pr-description-constructorfabric

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Pull request descriptions often bury reviewers in work logs, file lists, and unverified claims, making it hard to decide on a diff quickly. This Skill produces a PR body a reviewer can act on in under 30 seconds, with enforced word budgets and a fixed label structure. ## Core Features & Use Cases - Fixed body shape: Bold inline labels for Why, What changed, Out of scope, and Verified, plus bold-led lines for decisions the diff cannot show. - Size budgets: Word caps per block and per change type (fix vs. feature), with optional headings allowed only for feature-tier PRs. - Public-repo compliance: Enforces the AGENTS.md ban on production-derived data, requiring numbers from local stands, fixtures, or test runs, and screenshots from seeded local data. - Use Case: After finishing a bugfix branch, ask for a PR description; the Skill reads the branch commits and diff, asks about decisions only you know, drafts the body, and applies it via gh pr create or gh pr edit. ## Quick Start Write the PR description for my current branch and apply it with gh pr create.

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 good pull request description on GitHub?

Structure the body with bold inline labels: Why (the symptom), What changed (the mechanism), evidence such as screenshots or measured numbers, Out of scope when relevant, and Verified listing only what actually ran. Keep fixes under 100 words and features under 220 words.

How to update a PR body with the GitHub CLI?

Use gh pr edit <n> --body-file <file> to replace an existing body, or gh pr create --body-file <file> when opening a new pull request. Bot-appended blocks like coverage tables sit below the body and are not disturbed by re-posting.

Can I upload screenshots to a GitHub PR from the command line?

GitHub's user-attachments CDN is browser-only, so CLI tools cannot upload there. Push images to an orphan assets branch and link the raw.githubusercontent.com URL, or reuse URLs of images already pasted into the linked issue.

What should a PR description not include?

Avoid work logs, file lists CI already shows, claims about pending CI jobs, and production-derived data in public repos. Decisions should get their own bold-led line rather than being buried mid-paragraph, and empty Out of scope sections should be deleted.

When should a PR description use markdown headings?

Headings are reserved for feature-tier PRs only, at most one per body, from an optional list such as How it works or Open after this. Small fixes and chores use bold inline labels only, since multiple H2 headings make a short body read as a document.