From liangchenblue at gmail.com Mon Jul 3 07:55:55 2023 From: liangchenblue at gmail.com (-) Date: Mon, 3 Jul 2023 15:55:55 +0800 Subject: Bar for release notes Message-ID: Hi CSR group, Just curious, what is usually the condition for the requirement of a release note for CSR changes? Is it usually related to behavior changes to frequently-used APIs, and how large would a change be to require such a note? Chen Liang -------------- next part -------------- An HTML attachment was scrubbed... URL: From david.holmes at oracle.com Mon Jul 3 08:15:32 2023 From: david.holmes at oracle.com (David Holmes) Date: Mon, 3 Jul 2023 18:15:32 +1000 Subject: Bar for release notes In-Reply-To: References: Message-ID: <9bf3a1d0-c223-7790-21cf-332b3751422f@oracle.com> On 3/07/2023 5:55 pm, - wrote: > Hi CSR group, > Just curious, what is usually the condition for the requirement of a > release note for CSR changes? Is it usually related to behavior changes > to frequently-used APIs, and how large would a change be to require such > a note? There are no hard and fast rules here, it is very subjective and often happens because the CSR review process raises a request to add a Release Note. To me it is mainly a matter of how noticeable any change in behaviour, or change in API would be. Consider the number of changes in any given release of OpenJDk compared to the number of release notes - not many changes get release notes. That said a change doesn't have to be large to warrant a release note, it just has to be quite noticeable to anyone using the affected bit of code. Cheers, David > Chen Liang From joe.darcy at oracle.com Tue Jul 11 04:41:12 2023 From: joe.darcy at oracle.com (Joseph D. Darcy) Date: Mon, 10 Jul 2023 21:41:12 -0700 Subject: Bar for release notes In-Reply-To: <9bf3a1d0-c223-7790-21cf-332b3751422f@oracle.com> References: <9bf3a1d0-c223-7790-21cf-332b3751422f@oracle.com> Message-ID: <68a56194-1772-08c3-cb56-54b5aa3b7ef7@oracle.com> Hello, On 7/3/2023 1:15 AM, David Holmes wrote: > On 3/07/2023 5:55 pm, - wrote: >> Hi CSR group, >> Just curious, what is usually the condition for the requirement of a >> release note for CSR changes? Is it usually related to behavior >> changes to frequently-used APIs, and how large would a change be to >> require such a note? > > There are no hard and fast rules here, it is very subjective and often > happens because the CSR review process raises a request to add a > Release Note. > > To me it is mainly a matter of how noticeable any change in behaviour, > or change in API would be. Consider the number of changes in any given > release of OpenJDk compared to the number of release notes - not many > changes get release notes. That said a change doesn't have to be large > to warrant a release note, it just has to be quite noticeable to > anyone using the affected bit of code. > A few rough statistics for context: there are about 2,400 bug fixes/enhancements in a JDK feature release and about 150 CSRs. The items which get release notes may or may not have a corresponding CSR and, as David notes, one of the outcomes of CSR review is "please write a release note." Subjectively, if a change could be sufficiently surprising to users and isn't otherwise documented (as with a JEP, etc.), then the change should have a release note. HTH, -Joe