pr-body-style

Installation
SKILL.md

PR Body Style

Goal

Write PR bodies that are short, business-focused, and accurate to the actual code change. Assume reviewers can read the diff; the PR body should explain the outcome, validation, and any non-obvious context.

Style Rules

  • Preserve the repository's PR template headings unless the user asks to change the template.
  • Lead with the user/business outcome, reliability impact, or operational reason for the change.
  • Keep the description to 1 short paragraph plus 2-4 bullets when bullets help scanning.
  • Mention technical details only when they clarify behavior, reviewer risk, compatibility, CI impact, or deployment impact.
  • Avoid method-by-method or file-by-file narration unless the user explicitly asks for implementation detail.
  • Keep wording plain and direct. Prefer "Moves health checks to the standard gRPC health protocol" over deep root-cause prose.
  • Make every claim match the actual diff and current check status. Verify locally or with GitHub when the status may have changed.
  • Keep "How to Test" concrete and minimal: commands run, user-visible checks, or CI status.
  • Use "Additional Information" only for high-signal context, risks, retained compatibility shims, or follow-up notes. Keep it empty or one sentence when possible.

Accuracy Checks

Related skills
Installs
4
GitHub Stars
1
First Seen
4 days ago