Skip to content

Commit 09aedbf

Browse files
authored
Add release note categories section
1 parent b620250 commit 09aedbf

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,9 @@ for basics.
254254
where \<area\> describes which part of ExecuTorch the change pertains to, e.g.
255255
"Release notes: runtime". A few of these areas include "runtime", "backends",
256256
and "build". If you aren't sure whether to add a release label, you should
257-
probably still add one since it immensely facilitates release management.
257+
probably still add one since it immensely facilitates release management. Please
258+
refer to [Release note categories](#release-note-categories) for a list of
259+
standard release note categories.
258260
- See https://github.com/pytorch/executorch/pull/3612 for an example PR that
259261
follows this advice.
260262
1. Before asking for a review, ensure that all [CI (continuous integration)
@@ -283,6 +285,18 @@ for basics.
283285
will only merge PRs that fix the broken jobs until all critical jobs are
284286
fixed.
285287

288+
### Release note categories
289+
- `Release notes: runtime`: changes related to the core runtime which loads the program methods, initializes delegates, and runs the lowered graph.
290+
- `Release notes: exir`: changes to any internal representations, such as an edge-related dialects. Also any changes to passes that may modify the exir, such as memory planning.
291+
- `Release notes: quantization`: changes to quantization.
292+
- `Release notes: ops & kernels`: changes to the opset and any new / changed kernel implementations.
293+
- `Release notes: api`: changes to public facing apis (any interfaces, pybinded runtime methods, etc.).
294+
- `Release notes: backends`: changes to any of the backend delegates.
295+
- `Release notes: build`: changes related to the build system, including major dependency upgrades, notable build flags, optimizations, etc.
296+
- `Release notes: SDK`: changes to any of ExecuTorch's SDKs, for example the debugger & profiler.
297+
- `Release notes: examples`: changes to any of our example LLMs integrations, such as Llama3 and Llava.
298+
- `Release notes: misc`: anything notable that doesn't belong in the above categories.
299+
286300
&nbsp;
287301

288302
## For Backend Delegate Authors

0 commit comments

Comments
 (0)