template.md

July 14, 2026 · View on GitHub

Summary

{One-sentence TL;DR: this PR <verb> <behavior> so that <why>.}

Behavior changes

{1-3 short paragraphs, plain language, of what changes at runtime and why — the load-bearing content of this PR. Lead with the central mechanism (a feature flag, migration, state-machine edit, or config / API-contract change) and name its headline effect: a flag and its default, a migration's direction, the new vs. old behavior. Stay at the altitude of behavior and intent; do not enumerate every value, phase, or mode — the diff carries the specifics. Name internal flags or services on first use. A small table is fine only when several flags or modes genuinely interact. Omit this section entirely for pure refactors and docs-only PRs — in that case the Summary sentence stands alone.}

What to look at first

  • {Pointer to a decision, tradeoff, or risk the reviewer should weight, in suggested reading order. 2-4 bullets max. This is a reading-order guide for a large change, not a file list — GitHub's Files Changed tab is one click away.}