[PATCH] D123957: Update the developer policy to mention release notes

Aaron Ballman via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Tue Apr 19 11:14:56 PDT 2022

aaron.ballman updated this revision to Diff 423683.
aaron.ballman marked 3 inline comments as done.
aaron.ballman added a comment.

Updated based on review feedback.

- Made it more clear that adding a release note is discretionary rather than mandatory
- Clarified that bug fix release notes should be for user-facing impacts rather than any bug fix
- Clarified that optimization pass release notes should be for user-facing impacts rather than any change




Index: llvm/docs/DeveloperPolicy.rst
--- llvm/docs/DeveloperPolicy.rst
+++ llvm/docs/DeveloperPolicy.rst
@@ -180,6 +180,30 @@
 for coverage (correctness, performance, etc) testing, not feature or regression
+Release Notes
+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...
Name: D123957.423683.patch
Type: text/x-patch
Size: 1455 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20220419/52f37f7f/attachment.bin>

More information about the cfe-commits mailing list