Skip to content

Commit c4b4e98

Browse files
authored
Create pull_request_template.md (pytorch#5771)
1 parent a6328f0 commit c4b4e98

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

.github/pull_request_template.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### Summary
2+
[PLEASE REMOVE] See [CONTRIBUTING.md's Pull Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests) for ExecuTorch PR guidelines.
3+
4+
[PLEASE REMOVE] If this PR closes an issue, please add a `Fixes #<issue-id>` line.
5+
6+
[PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add a "Release notes: <area>" label. For a list of available release notes labels, check out [CONTRIBUTING.md's Pull Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests).
7+
8+
### Test plan
9+
[PLEASE REMOVE] How did you test this PR? Please write down any manual commands you used and note down tests that you have written if applicable.

CONTRIBUTING.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -242,14 +242,27 @@ for basics.
242242
- Give the PR a clear and thorough description. Don't just describe what the PR
243243
does: the diff will do that. Explain *why* you are making this change, in a
244244
way that will make sense to someone years from now.
245-
- Add the line `Test Plan:` (with that spelling, capitalization, and trailing
246-
colon character), followed by lines containing repeatable instructions for
245+
- Explain how you have tested your changes by including repeatable instructions for
247246
testing the PR.
248247
- If you added tests, this can be as simple as the command you used to run the
249248
tests.
250249
- If you tested the PR manually, include the steps and the outputs. Help a
251250
future editor understand how to test the code that you're modifying
252251
today.
252+
- If your PR contains or is representative of a feature/bug fix that should be
253+
called out in the release notes, please add a label for "Release notes: \<area\>",
254+
where \<area\> describes which part of ExecuTorch the change pertains to, e.g.
255+
"Release notes: runtime". Here are all of the categories:
256+
- `Release notes: runtime`: changes related to the core runtime which loads the program methods, initializes delegates, and runs the lowered graph.
257+
- `Release notes: exir`: changes to any internal representations, such as any edge-related dialects. Also any changes to passes that may modify the exir, such as memory planning.
258+
- `Release notes: quantization`: changes to quantization.
259+
- `Release notes: ops & kernels`: changes to the opset and any new / changed kernel implementations.
260+
- `Release notes: api`: changes to public facing apis (any interfaces, pybinded runtime methods, etc.).
261+
- `Release notes: backends`: changes to any of the backend delegates.
262+
- `Release notes: build`: changes related to the build system, including major dependency upgrades, notable build flags, optimizations, etc.
263+
- `Release notes: devtools`: changes to any of ExecuTorch's developer tools, for example the debugger & profiler.
264+
- `Release notes: examples`: changes to any code under `examples/`.
265+
- `Release notes: misc`: anything notable that doesn't belong in the above categories.
253266
- See https://github.com/pytorch/executorch/pull/3612 for an example PR that
254267
follows this advice.
255268
1. Before asking for a review, ensure that all [CI (continuous integration)

0 commit comments

Comments
 (0)