Skip to content

Commit 3c7fef2

Browse files
committed
Add pull request template
1 parent 44389d2 commit 3c7fef2

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+
This template is a guide, not a gate. Use as much or as little as helps the
3+
reviewer understand your change. For straightforward PRs (dependency bumps,
4+
linting fixes, CI tweaks, typos) a one-liner description is perfectly fine
5+
-- delete the sections that don't add value.
6+
7+
Rule of thumb: the more the change affects behavior, the more sections you
8+
should fill in.
9+
-->
10+
11+
# Why
12+
13+
<!-- Problem statement: what's broken/slow/confusing/missing today? (1-3 sentences) -->
14+
15+
<!-- Goal: what outcome does this PR achieve? -->
16+
17+
<!-- Non-goals: what this PR intentionally does NOT do (prevents scope creep) -->
18+
19+
Closes <!-- #issue -->
20+
21+
## What changed
22+
23+
<!-- Group changes by intent, not by file. -->
24+
25+
<!-- Behavioral changes: what users/systems will observe differently -->
26+
-
27+
28+
<!-- Implementation notes: key design choices, tradeoffs, notable refactors -->
29+
30+
<!-- What stayed the same: especially useful if you touched sensitive areas -->
31+
<!-- e.g., "No schema changes", "API contract unchanged", "Only affects branch X" -->
32+
33+
<!-- If the diff is large, add a suggested review order:
34+
### Suggested review order
35+
1. Start with ...
36+
2. Then ...
37+
3. Tests are ...
38+
-->
39+
40+
## How to review
41+
42+
<!-- Key files/areas to focus on vs. mechanical/generated changes -->
43+
44+
<!-- Risky or uncertain parts where you want extra scrutiny -->
45+
46+
<!-- Alternatives considered (only if it affects future direction) -->
47+
48+
## How to test
49+
50+
<!-- Make it runnable and specific -->
51+
52+
```bash
53+
# Commands to validate
54+
```
55+
56+
<!-- Expected outputs, screenshots, or links to CI results -->
57+
58+
## Impact & rollout
59+
60+
<!-- Delete items that don't apply -->
61+
62+
- **Backward compatibility:** <!-- any breaking changes or migration steps -->
63+
- **Performance:** <!-- implications, measurements if relevant -->
64+
- **Config/env changes:** <!-- new settings, feature flags, env vars -->
65+
- **Deployment notes:** <!-- "safe to deploy" vs "requires coordinated release" -->
66+
67+
## Checklist
68+
69+
- [ ] Tests added/updated
70+
- [ ] Changelog entry added (`uv run towncrier create ...`)
71+
- [ ] External docs updated (if user-facing or ops-facing change)
72+
- [ ] Internal .md docs updated (internal knowledge and AI code tools knowledge)

0 commit comments

Comments
 (0)