Index: llvm/docs/DeveloperPolicy.rst =================================================================== --- llvm/docs/DeveloperPolicy.rst +++ llvm/docs/DeveloperPolicy.rst @@ -180,6 +180,25 @@ 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 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. +* 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 -------