Skip to content

Commit 009048a

Browse files
committed
Update the developer policy to mention release notes
As a project, Clang has gotten negative public feedback about our lack of communicating changes to users. There are comments on places like Hacker News or Reddit where users have (rightfully) been confused as to what changes happen in a given release, leading to misinformation like Clang not adding support for C++20 features: https://news.ycombinator.com/item?id=28761464. This documents the expectation that changes which impact users should have release notes, and it's normal for code reviewers to ask an author to add a release note for a given change. This addresses: llvm/llvm-project#54965 RFC: https://discourse.llvm.org/t/rfc-update-developer-policy-on-release-notes/61856 Differential Revision: https://reviews.llvm.org/D123957
1 parent a5c847e commit 009048a

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

llvm/docs/DeveloperPolicy.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,30 @@ etc) should be added to the ``llvm-test`` test suite. The llvm-test suite is
180180
for coverage (correctness, performance, etc) testing, not feature or regression
181181
testing.
182182

183+
Release Notes
184+
-------------
185+
186+
Many projects in LLVM communicate important changes to users through release
187+
notes, typically found in ``docs/ReleaseNotes.rst`` for the project. Changes to
188+
a project that are user-facing, or that users may wish to know about, should be
189+
added to the project's release notes at the author's or code reviewer's
190+
discretion, preferably as part of the commit landing the changes. Examples of
191+
changes that would typically warrant adding a release note (this list is not
192+
exhaustive):
193+
194+
* Adding, removing, or modifying command-line options.
195+
* Adding, removing, or regrouping a diagnostic.
196+
* Fixing a bug that potentially has significant user-facing impact (please link
197+
to the issue fixed in the bug database).
198+
* Adding or removing optimizations that have widespread impact or enables new
199+
programming paradigms.
200+
* Modifying a C stable API.
201+
* Notifying users about a potentially disruptive change expected to be made in
202+
a future release, such as removal of a deprecated feature.
203+
204+
Code reviewers are encouraged to request a release note if they think one is
205+
warranted when performing a code review.
206+
183207
Quality
184208
-------
185209

0 commit comments

Comments
 (0)