| name | pr-description |
| description | The standard for PR descriptions: succinct, unformatted, at most two short paragraphs covering what was fixed and any non-obvious decisions. Other skills reference it when opening a PR or judging an existing description. Use when writing or reviewing a PR description. |
Write a normal first draft, then tighten it against the [[plain-english]] standard and every rule below.
Form:
- At most two paragraphs: what was fixed, then the reasons behind the non-obvious choices. Include the second only when it earns its place.
- Each paragraph is two or three simple sentences of one or two lines each, so the longest runs about six lines and most run two or three.
- Say everything exactly once. Cut every repetition, however important the point, and never restate for emphasis.
- Plain prose only. No bold, italics, all-caps, bullet lists, headers, or dashes as connectors. Allow a header only in the rare case one is genuinely warranted. Keep Markdown near zero.
First paragraph, what was fixed:
- When a ticket or issue exists, open with
Fixed: <link> or Addressed: <link>; otherwise start straight in.
- Then one or two sentences on what was actually fixed, meaning the real change rather than the ticket title or the reported symptom. Not "loading was slow" but "optimized loading in module X by removing the exponential backoff".
Second paragraph, the reasons:
- Include only choices and trade-offs a reader cannot infer from the diff: why this approach over the alternative, and what it buys. Never what the code already shows.
- If every change is self-evident from the diff, omit this paragraph entirely. Never narrate the diff ("removed comments", "simplified loop").
