[PATCH] D123957: Update the developer policy to mention release notes
Aaron Ballman via Phabricator via cfe-commits
cfe-commits at lists.llvm.org
Wed Apr 20 08:36:51 PDT 2022
This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.
Closed by commit rG009048ab314f: Update the developer policy to mention release notes (authored by aaron.ballman).
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
@@ -180,6 +180,30 @@
for coverage (correctness, performance, etc) testing, not feature or regression
+Many projects in LLVM communicate important changes to users through release
+notes, typically found in ``docs/ReleaseNotes.rst`` for the project. Changes to
+a project that are user-facing, or that users may wish to know about, should be
+added to the project's release notes at the author's or code reviewer's
+discretion, preferably as part of the commit landing the changes. Examples of
+changes that would typically warrant adding a release note (this list is not
+* Adding, removing, or modifying command-line options.
+* Adding, removing, or regrouping a diagnostic.
+* Fixing a bug that potentially has significant user-facing impact (please link
+ to the issue fixed in the bug database).
+* Adding or removing optimizations that have widespread impact or enables new
+ programming paradigms.
+* Modifying a C stable API.
+* Notifying users about a potentially disruptive change expected to be made in
+ a future release, such as removal of a deprecated feature.
+Code reviewers are encouraged to request a release note if they think one is
+warranted when performing a code review.
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 1455 bytes
Desc: not available
More information about the cfe-commits