RFR: Section on release notes [v6]
Jesper Wilhelmsson
jwilhelm at openjdk.java.net
Tue Mar 22 00:20:40 UTC 2022
On Fri, 18 Mar 2022 17:26:07 GMT, calnan <duke at openjdk.java.net> wrote:
>> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
>>
>> Rewritten and added more info.
>
> src/index.md line 1553:
>
>> 1551: When writing a release note, be prepared for rather picky review comments about grammar, typos, and wording. This is for the sake of the Java community as a whole, as the language of the release note sets the tone for many blogs and news articles. For a widely used product like the JDK, the release notes are often copied verbatim (including typos) and published to highlight news in the release. This means that we need to take extra care to make sure the text in the release note is correct and has a professional language.
>> 1552:
>> 1553: The release note itself is written in a [JBS](#jbs---jdk-bug-system) sub-task to the issue that is used to push the change. There are a few steps to follow for the release note to find its way from JBS to the actual release note document.
>
> Suggestion:
>
> The release note itself is written in a [JBS](#jbs---jdk-bug-system) sub-task linked to the issue that is used to push the change. There are a few steps to follow for the release note to find its way from JBS to the actual release note document.
Going with "of" as pointed out by David below.
> src/index.md line 1604:
>
>> 1602: ## RN-labels
>> 1603:
>> 1604: Unless tagged otherwise it will be assumed that the release note documents a change in behavior (will have likely required a CSR) or other item which should be included in the release notes. If the note covers a more specific type of change, then one of the following labels can be included (notes of a similar type will be listed together).
>
> s/tagged/labeled/ ?
Yes, labeled.
-------------
PR: https://git.openjdk.java.net/guide/pull/75
More information about the guide-dev
mailing list