diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst --- a/llvm/docs/DeveloperPolicy.rst +++ b/llvm/docs/DeveloperPolicy.rst @@ -180,6 +180,30 @@ 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 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 +exhaustive): + +* 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. + Quality -------