-
Notifications
You must be signed in to change notification settings - Fork 722
Create pull_request_template.md #5771
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 11 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
bfc746f
Create pull_request_template.md
jackzhxng a05b223
Update pull_request_template.md
jackzhxng 3885772
Update .github/pull_request_template.md
jackzhxng 2a7321b
Update pull_request_template.md
jackzhxng 60cc231
Update pull_request_template.md
jackzhxng d9bd2af
Update pull_request_template.md
jackzhxng 0c8812f
Update pull_request_template.md
jackzhxng c187a57
Dave comments
jackzhxng b5b3185
Update CONTRIBUTING.md
jackzhxng 4caacdd
Add categories
jackzhxng bf4b7e1
Lint
jackzhxng e8903db
Update pull_request_template.md
jackzhxng 5d13a9f
Update CONTRIBUTING.md
jackzhxng File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| ### Summary | ||
| [PLEASE REMOVE] Describe the goal of this PR and add any relevant context. | ||
|
|
||
| [PLEASE REMOVE] If this PR closes an issue, please add a `Fixes #<issue-id>` line. | ||
|
|
||
| [PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add a "Release notes: <area>" label. | ||
jackzhxng marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Test plan | ||
dbort marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| [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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -242,14 +242,27 @@ for basics. | |||||
| - Give the PR a clear and thorough description. Don't just describe what the PR | ||||||
jackzhxng marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| does: the diff will do that. Explain *why* you are making this change, in a | ||||||
| way that will make sense to someone years from now. | ||||||
| - Add the line `Test Plan:` (with that spelling, capitalization, and trailing | ||||||
| colon character), followed by lines containing repeatable instructions for | ||||||
| - Explain how you have tested your changes by including repeatable instructions for | ||||||
jackzhxng marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| testing the PR. | ||||||
| - If you added tests, this can be as simple as the command you used to run the | ||||||
| tests. | ||||||
| - If you tested the PR manually, include the steps and the outputs. Help a | ||||||
| future editor understand how to test the code that you're modifying | ||||||
| today. | ||||||
| - If your PR contains or is representative of a feature/bug fix that should be | ||||||
jackzhxng marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| called out in the release notes, please add a label for "Release notes: \<area\>", | ||||||
jackzhxng marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| where \<area\> describes which part of ExecuTorch the change pertains to, e.g. | ||||||
| "Release notes: runtime". Here are all of the categories: | ||||||
| - `Release notes: runtime`: changes related to the core runtime which loads the program methods, initializes delegates, and runs the lowered graph. | ||||||
| - `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. | ||||||
| - `Release notes: quantization`: changes to quantization. | ||||||
| - `Release notes: ops & kernels`: changes to the opset and any new / changed kernel implementations. | ||||||
| - `Release notes: api`: changes to public facing apis (any interfaces, pybinded runtime methods, etc.). | ||||||
| - `Release notes: backends`: changes to any of the backend delegates. | ||||||
| - `Release notes: build`: changes related to the build system, including major dependency upgrades, notable build flags, optimizations, etc. | ||||||
| - `Release notes: SDK`: changes to any of ExecuTorch's SDKs, for example the debugger & profiler. | ||||||
jackzhxng marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| - `Release notes: examples`: changes to any of our example LLMs integrations, such as Llama3 and Llava. | ||||||
|
||||||
| - `Release notes: examples`: changes to any of our example LLMs integrations, such as Llama3 and Llava. | |
| - `Release notes: examples`: changes to any code under `examples/`. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.