Repository navigation
docs: add a Risk section to the PR template - #37101
Conversation
|
No actionable comments were generated in the recent review.
|
Review statusThe problem: PR descriptions had no place to say what a change could break, who it affects, or how to back it out, so reviewers had to infer the blast radius from the diff. The change for users (PR authors and reviewers): new PRs opened from the template now include a Review (light path): one fresh adversarial reviewer confirmed each light-path criterion in the code: one file, +7 lines; no app, CI, build or release code; the file's only other changes in the last 30 days are #29692 (typos) and #26328 (stale doc pointer); the effect is local. It found nothing that reads PR bodies or the template by heading (the LoC summary rewriter finds its place by its own Fixed: the PR body's review-path lines now mention #26328 and no longer say "0 production lines", which disagreed with the LoC table. Deferred (wording nits, no defect): a blank Level line renders as a bare bold "Level:" (the same as the template's existing Verified: CI green on the head (PR Checks run 41336080187), no conflicts. QA: none needed (template text only). For Brennan's review:
|
ELI5
PR descriptions had no place to say what a change could break. This adds a Risk section to the PR template so every PR states it up front.
What Changed
.github/pull_request_template.md: new## Risksection after Testing. It asks what could break and for whom, what users would see if it went wrong, anything that crosses a boundary (saved data or settings, older paired phones or SSH servers, other platforms, agents, performance), and how to back the change out. It ends with a**Level:**line for Low, Medium or High. The Checklist gains a matching "I stated the risk" item.Why
Reviewers had to infer blast radius and rollback from the diff. Asking for it explicitly, with a one-word level, lets reviewers triage faster and makes risky PRs stand out.
Linked Issue
N/A (maintainer change, no pre-existing issue).
Visual Proof
N/A: template and docs text only; no app UI or behavior change.
Testing
Nothing in the repo parses the template's section headings (checked
src/shared/pull-request-generation.tsandconfig/scripts/pr-test-loc-summary*), so no code or test depends on the new section.Risk
What could break: nothing in the app; this only changes text GitHub pre-fills for new PRs. Back out with a plain revert.
Level: Low
Review path
Light path:
.github/pull_request_template.md, template text only; CI's change-scope check treats it as docs).Plan: add one
## Risksection after Testing with a guiding comment and a Low / Medium / High level line, one checklist item.