Skip to content

Commit d3adc63

Browse files
[sync] Create .github/pull_request_template.md
1 parent 1e12939 commit d3adc63

1 file changed

Lines changed: 72 additions & 0 deletions

File tree

‎.github/pull_request_template.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<!--
2+
Org-wide PR template — SYNCED from nsheaps/.github
3+
(ansible/templates/.github/pull_request_template.md). Local edits are
4+
replaced on the next org sync run; propose changes upstream instead.
5+
6+
Delete any section that genuinely does not apply. Do not delete
7+
"Blast radius" or "Validation performed" — if they are empty, say why.
8+
-->
9+
10+
## What changed
11+
12+
<!--
13+
The actual diff, file by file, in the order a reviewer should read it.
14+
A table works well when several files change for different reasons.
15+
Link to specific lines (`path/to/file.py:120-134`) rather than describing.
16+
-->
17+
18+
## Why
19+
20+
<!--
21+
The problem or requirement this serves. If it came from an issue, a
22+
review comment, or an incident, link it. "Because it was asked for" is
23+
a real reason — say who asked and where.
24+
-->
25+
26+
## Blast radius
27+
28+
<!--
29+
READ THIS SECTION BEFORE APPROVING.
30+
31+
Answer concretely:
32+
- What is affected? (this repo only / N managed repos / all org members)
33+
- When does it take effect? (on merge / on next sync / only for new repos)
34+
- What breaks if this is wrong? What is the rollback?
35+
- What existing behaviour or local decision does this override?
36+
37+
If the change is genuinely inert today (feature-flagged, enforcement
38+
disabled, no consumer yet), say so AND say what would make it live.
39+
-->
40+
41+
## Validation performed
42+
43+
<!--
44+
Paste REAL output — command invocations and their actual results. Not
45+
"tests pass", not a description of what you would run.
46+
47+
Where a test is meant to catch a regression, show that it actually fails
48+
without the fix. An assertion that never fails is not validation.
49+
-->
50+
51+
```
52+
$ <command>
53+
<output>
54+
```
55+
56+
## What a reviewer should scrutinise
57+
58+
<!--
59+
The parts you are least sure about, the trade-offs you made, and any
60+
decision you made unilaterally that the reviewer might have made
61+
differently. Pre-empt the strongest objection to this PR rather than
62+
waiting for review to find it.
63+
-->
64+
65+
1.
66+
2.
67+
68+
## Related
69+
70+
<!-- Issues, prior PRs, specs, Discord threads. Use "Closes #N" to auto-close. -->
71+
72+
-

0 commit comments

Comments
 (0)