aaron.ballman updated this revision to Diff 423594. aaron.ballman added a comment.
Something went funny during a rebase, so this is the full update, not just changes since last time. CHANGES SINCE LAST ACTION https://reviews.llvm.org/D123957/new/ https://reviews.llvm.org/D123957 Files: llvm/docs/DeveloperPolicy.rst Index: llvm/docs/DeveloperPolicy.rst =================================================================== --- llvm/docs/DeveloperPolicy.rst +++ llvm/docs/DeveloperPolicy.rst @@ -180,6 +180,27 @@ for coverage (correctness, performance, etc) testing, not feature or regression testing. +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, 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 + 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. + Quality -------
Index: llvm/docs/DeveloperPolicy.rst =================================================================== --- llvm/docs/DeveloperPolicy.rst +++ llvm/docs/DeveloperPolicy.rst @@ -180,6 +180,27 @@ for coverage (correctness, performance, etc) testing, not feature or regression testing. +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, 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 + 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. + Quality -------
_______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
