RFR: Section on release notes [v2]
Iris Clark
iris at openjdk.java.net
Sat Feb 19 00:21:04 UTC 2022
On Fri, 18 Feb 2022 22:56:42 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:
>> The meat of the procedure here was inspired by Daniel Fuchs' comment in JDK-8273727.
>> [[JDK-8273727] (prop) Canonical property storage - Java Bug System](https://bugs.openjdk.java.net/browse/JDK-8273727?focusedCommentId=14448738&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-14448738)
>
> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
>
> Fixes after reviews from David and Lance
Looks good!
src/index.md line 1540:
> 1538: :::
> 1539:
> 1540: Release notes for a product (e.g. the JDK) are part of the release deliverables. They describe changes that are important for a user of the product to know about. This is usually things that may affect the user's decision to upgrade to the specific version.
"to know about. This is usually" -> "to know. These are usually"
src/index.md line 1542:
> 1540: Release notes for a product (e.g. the JDK) are part of the release deliverables. They describe changes that are important for a user of the product to know about. This is usually things that may affect the user's decision to upgrade to the specific version.
> 1541:
> 1542: When writing a release note for your feature, 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 (word by word, 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.
Consider: "are often copied (word by word, including typos)" -> are often copied verbatim (including typos)"
src/index.md line 1544:
> 1542: When writing a release note for your feature, 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 (word by word, 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.
> 1543:
> 1544: The release note itself is written in a JBS sub-task to the issue that is used to push the change. There are a few steps to follow in order for the release note to find its way from JBS to the actual release note document.
Consider: "to follow in order for the release note" -> "to follow for the release note"
-------------
Marked as reviewed by iris (Reviewer).
PR: https://git.openjdk.java.net/guide/pull/75
More information about the guide-dev
mailing list