[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 04:26:58 PDT 2022

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

Updating based on review feedback.

Fixed some grammar issues, added a bullet for fixing bugs, modified the bullet about diagnostics to include regrouping under a new diagnostic name.




Index: llvm/docs/DeveloperPolicy.rst
--- llvm/docs/DeveloperPolicy.rst
+++ llvm/docs/DeveloperPolicy.rst
@@ -185,12 +185,14 @@
 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 users may wish to know about should be added
-to the project's release notes. Examples of changes that would typically
-warrant adding a release note (this list is not exhaustive):
-* Adding, removing, or modifying command line options.
-* Adding or removing a diagnostic.
+a project that are user-facing, or that users may wish to know about, should be
+added to the project's release notes, preferably as part of the commit landing
+the changes. Examples of changes that would typically warrant adding a release
+note (this list is not exhaustive):
+* Adding, removing, or modifying command-line options.
+* Adding, removing, or regrouping a diagnostic.
+* Fixing a bug (please link to the issue fixed in the bug database).
 * Adding or removing an optimization.
 * Modifying a C stable API.
 * Notifying users about a potentially disruptive change expected to be made in

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D123957.423593.patch
Type: text/x-patch
Size: 1269 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20220419/fa68c7c2/attachment.bin>

More information about the cfe-commits mailing list