Skip to content

Commit c767930

Browse files
authored
Add a standardized pull request template (#4655)
This PR introduces a standardized pull request template setup to improve review quality and consistency. ## Summary - Adds a new default PR template at `.github/pull_request_template.md`. - Standardizes PR submissions with consistent sections for context and validation. - Establishes a single source of truth for PR guidance. ## Why - A unified template improves review quality and consistency. - It reduces ambiguity for contributors when describing changes and test coverage. - Centralizing guidance makes future maintenance simpler.
1 parent 447795b commit c767930

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

.github/pull_request_template.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<!--
2+
Title (for the Pull Request title field at the top):
3+
Use a short prefix so the change type is obvious. You do not need to repeat it in the body below.
4+
5+
Examples:
6+
- fix: — bugfix
7+
- feat: — feature
8+
- refactor: — internal change without user-facing feature
9+
- docs: — documentation only
10+
- chore: — tooling, CI, deps, build housekeeping
11+
- test: — tests only
12+
-->
13+
14+
## Linked issue (required)
15+
16+
<!-- Fixes #123 / Closes #123 / Refs #123 -->
17+
18+
## Summary / motivation (required)
19+
20+
<!-- What this PR does and why. For larger changes, add enough context for reviewers. -->
21+
22+
## Steps to reproduce (required, use N/A if not applicable)
23+
24+
<!-- Steps to reproduce: how to trigger the bug in the broken state (the "before").
25+
- Mainly for bugfixes;
26+
- For bugs: numbered steps before the fix. For non-bugs: write N/A.
27+
- use N/A for features, refactors, docs, chore, etc.
28+
-->
29+
30+
1.
31+
2.
32+
3.
33+
34+
## How to test (required)
35+
36+
<!--- How to test: how you verified the change (checks, unit tests, manual steps, edge cases — the "after" or general validation). --->
37+
38+
### Checklist (minimum)
39+
40+
- [ ] I ran `./ninja check` or an equivalent relevant check locally.
41+
- [ ] I added or updated tests when the change is non-trivial or behavior changed.
42+
43+
### Details
44+
45+
<!-- Commands, manual steps, edge cases, and what you observed -->
46+
47+
## Before / after behavior (optional)
48+
49+
<!-- For bugfixes: behavior before vs after. For other types: N/A or a short note. -->
50+
51+
## Risk / compatibility / migration (optional)
52+
53+
<!-- Breaking changes, rollout notes, or N/A for small / low-risk PRs -->
54+
55+
## UI evidence (required for visual changes; otherwise N/A)
56+
57+
<!-- Screenshot or short video -->
58+
59+
## Scope
60+
61+
- [ ] This PR is focused on one change (no unrelated edits).

0 commit comments

Comments
 (0)