From bfc746fdd23eeec1fb94b09a46441c12d13fab1f Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Mon, 30 Sep 2024 14:48:00 -0700 Subject: [PATCH 01/13] Create pull_request_template.md --- .github/pull_request_template.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000000..524bb203c65 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ +### Description + +### Test plan + +### Issue(s) fixed + +### Changelog From a05b2236ee87d0cd15555a99237bfa074f6b9540 Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Mon, 30 Sep 2024 14:55:09 -0700 Subject: [PATCH 02/13] Update pull_request_template.md --- .github/pull_request_template.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 524bb203c65..45814989bee 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,11 @@ ### Description +[PLEASE REMOVE] Describe the goal of this PR and any add any relevant context. ### Test plan +[PLEASE REMOVE] How did you test this PR? Please write down any manual commands you used and note down tests that you have written. ### Issue(s) fixed +[PLEASE REMOVE] List all issues, separate by returns, that this PR addresses. ### Changelog +[PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add the following line below - `+changelog: ` From 38857727c83e8ce92ec430a62a63b0f23356df2b Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Mon, 30 Sep 2024 15:22:43 -0700 Subject: [PATCH 03/13] Update .github/pull_request_template.md Co-authored-by: Dave Bort --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 45814989bee..658c19d0f46 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,7 +5,7 @@ [PLEASE REMOVE] How did you test this PR? Please write down any manual commands you used and note down tests that you have written. ### Issue(s) fixed -[PLEASE REMOVE] List all issues, separate by returns, that this PR addresses. +[PLEASE REMOVE] List all issues, separate by newlines, that this PR addresses. ### Changelog [PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add the following line below - `+changelog: ` From 2a7321bc2fc230cdfd22f56ead614631bf6616d4 Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Mon, 30 Sep 2024 15:26:33 -0700 Subject: [PATCH 04/13] Update pull_request_template.md --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 658c19d0f46..bd6307d8171 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,11 +1,11 @@ -### Description +### Summary [PLEASE REMOVE] Describe the goal of this PR and any add any relevant context. ### Test plan [PLEASE REMOVE] How did you test this PR? Please write down any manual commands you used and note down tests that you have written. ### Issue(s) fixed -[PLEASE REMOVE] List all issues, separate by newlines, that this PR addresses. +[PLEASE REMOVE] List all issues fixed (e.g. "closes #ISSUE_NUMBER"), separate by newlines, that this PR addresses. ### Changelog [PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add the following line below - `+changelog: ` From 60cc2319373b1cc13e00cc48d300a78734635c64 Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Mon, 30 Sep 2024 16:32:03 -0700 Subject: [PATCH 05/13] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bd6307d8171..302fc7b6257 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,4 +8,4 @@ [PLEASE REMOVE] List all issues fixed (e.g. "closes #ISSUE_NUMBER"), separate by newlines, that this PR addresses. ### Changelog -[PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add the following line below - `+changelog: ` +[PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add the following "Release notes: " label. From d9bd2affc0eb319b90159f177ce6f27945b54095 Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Tue, 1 Oct 2024 11:28:08 -0700 Subject: [PATCH 06/13] Update pull_request_template.md --- .github/pull_request_template.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 302fc7b6257..8de6948af7c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,11 +1,9 @@ ### Summary [PLEASE REMOVE] Describe the goal of this PR and any add any relevant context. -### Test plan -[PLEASE REMOVE] How did you test this PR? Please write down any manual commands you used and note down tests that you have written. - -### Issue(s) fixed -[PLEASE REMOVE] List all issues fixed (e.g. "closes #ISSUE_NUMBER"), separate by newlines, that this PR addresses. +[PLEASE REMOVE] If this PR closes an issue, please add a `Closes #` line. -### Changelog [PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add the following "Release notes: " label. + +### Test plan +[PLEASE REMOVE] How did you test this PR? Please write down any manual commands you used and note down tests that you have written. From 0c8812f7fb2376c05e6125e5100ef5937dd286cd Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Tue, 1 Oct 2024 11:46:50 -0700 Subject: [PATCH 07/13] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8de6948af7c..1ea5e7361eb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,7 @@ ### Summary [PLEASE REMOVE] Describe the goal of this PR and any add any relevant context. -[PLEASE REMOVE] If this PR closes an issue, please add a `Closes #` line. +[PLEASE REMOVE] If this PR closes an issue, please add a `Fixes #` line. [PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add the following "Release notes: " label. From c187a577dbe451de0eb5e76001b4b9a0623020b3 Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Thu, 3 Oct 2024 10:58:15 -0700 Subject: [PATCH 08/13] Dave comments --- .github/pull_request_template.md | 2 +- CONTRIBUTING.md | 9 +++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1ea5e7361eb..f1cdaa98e89 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,7 +3,7 @@ [PLEASE REMOVE] If this PR closes an issue, please add a `Fixes #` line. -[PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add the following "Release notes: " label. +[PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add a "Release notes: " label. ### Test plan [PLEASE REMOVE] How did you test this PR? Please write down any manual commands you used and note down tests that you have written. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d434c1fe198..908103af248 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -242,14 +242,19 @@ for basics. - Give the PR a clear and thorough description. Don't just describe what the PR 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 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 + called out in the release notes, please add a label for "Release notes: ", + where describes which part of ExecuTorch the change pertains to, e.g. + "Release notes: runtime". A few of these areas include "runtime", "backends", + and "build". If you aren't sure whether to add a release label, you should + probably still add one since it immensely facilitates release management. - See https://github.com/pytorch/executorch/pull/3612 for an example PR that follows this advice. 1. Before asking for a review, ensure that all [CI (continuous integration) From b5b3185ab1eba525edc021cde3d91e06db28f912 Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Thu, 3 Oct 2024 11:17:50 -0700 Subject: [PATCH 09/13] Update CONTRIBUTING.md --- .github/pull_request_template.md | 5 +++-- CONTRIBUTING.md | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f1cdaa98e89..d79c30808c8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,10 @@ ### Summary -[PLEASE REMOVE] Describe the goal of this PR and any add any relevant context. +[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 #` line. [PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add a "Release notes: " label. ### Test plan -[PLEASE REMOVE] How did you test this PR? Please write down any manual commands you used and note down tests that you have written. +[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. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 908103af248..be443d43b67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -250,8 +250,8 @@ for basics. 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 - called out in the release notes, please add a label for "Release notes: ", - where describes which part of ExecuTorch the change pertains to, e.g. + called out in the release notes, please add a label for "Release notes: \", + where \ describes which part of ExecuTorch the change pertains to, e.g. "Release notes: runtime". A few of these areas include "runtime", "backends", and "build". If you aren't sure whether to add a release label, you should probably still add one since it immensely facilitates release management. From 4caacdd347eb47447cfe67bc94a9e68103eb7ec7 Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Tue, 29 Oct 2024 13:10:34 -0700 Subject: [PATCH 10/13] Add categories --- CONTRIBUTING.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be443d43b67..d7626ecbef5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -252,9 +252,17 @@ for basics. - If your PR contains or is representative of a feature/bug fix that should be called out in the release notes, please add a label for "Release notes: \", where \ describes which part of ExecuTorch the change pertains to, e.g. - "Release notes: runtime". A few of these areas include "runtime", "backends", - and "build". If you aren't sure whether to add a release label, you should - probably still add one since it immensely facilitates release management. + "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. + - `Release notes: examples`: changes to any of our example LLMs integrations, such as Llama3 and Llava. + - `Release notes: misc`: anything notable that doesn't belong in the above categories. - See https://github.com/pytorch/executorch/pull/3612 for an example PR that follows this advice. 1. Before asking for a review, ensure that all [CI (continuous integration) From bf4b7e1146700e52e30f3669113a7fe9dbc01c07 Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Wed, 30 Oct 2024 21:24:52 -0400 Subject: [PATCH 11/13] Lint --- .github/pull_request_template.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d79c30808c8..3031553afb5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,4 +7,3 @@ ### Test plan [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. - From e8903dba36d5bdf38eec04f5c00f0ef3ac1f389c Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Fri, 1 Nov 2024 07:39:05 -0700 Subject: [PATCH 12/13] Update pull_request_template.md --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3031553afb5..e2130d57bde 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,9 @@ ### Summary -[PLEASE REMOVE] Describe the goal of this PR and add any relevant context. +[PLEASE REMOVE] See [CONTRIBUTING.md's Pull Requests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#pull-requests) for ExecuTorch PR guidelines. [PLEASE REMOVE] If this PR closes an issue, please add a `Fixes #` line. -[PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add a "Release notes: " label. +[PLEASE REMOVE] If this PR introduces a fix or feature that should be the upcoming release notes, please add a "Release notes: " 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). ### Test plan [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. From 5d13a9fc53e69063e0653349d691d6314c410016 Mon Sep 17 00:00:00 2001 From: Jack Zhang Date: Fri, 1 Nov 2024 07:40:26 -0700 Subject: [PATCH 13/13] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7626ecbef5..886780a7d8d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -260,8 +260,8 @@ for basics. - `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. - - `Release notes: examples`: changes to any of our example LLMs integrations, such as Llama3 and Llava. + - `Release notes: devtools`: changes to any of ExecuTorch's developer tools, for example the debugger & profiler. + - `Release notes: examples`: changes to any code under `examples/`. - `Release notes: misc`: anything notable that doesn't belong in the above categories. - See https://github.com/pytorch/executorch/pull/3612 for an example PR that follows this advice.