RFR: Section on release notes

[David Holmes]

On Fri, 18 Feb 2022 01:54:43 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)

Seems quite reasonable and accurate. A couple of comments/suggestions.

Thanks,
David

src/index.md line 1549:

> 1547: #. Create a sub-task of the same JBS issue that you want a release note for (not of the CSR).
> 1548:    * Prefix the name of the sub-task with "Release Note:".
> 1549:    * The title of the release note sub-task should be a one sentence synopsis that is informative (and concise) enough to attract the attention of users, developers, and maintainers who might be impacted by the change.

The title should succinctly describe what has actually changed, not be the original bug title, nor describe the problem that was being solved. It should real well as a sub-section heading in a document.

src/index.md line 1554:

> 1552:    * Assign the sub-task to the person who should write the release note.
> 1553:    * Set the Fix Version of the sub-task to the same value that the main issue has.
> 1554:    * Enter the text of the release note in the **Description** field. Some markdown formatting is available (even though it's not rendered in JBS).

Suggestion:

Enter the text of the release note in the **Description** field using markdown formatting (even though it won't be rendered in JBS).

-------------

Marked as reviewed by dholmes (Author).

PR: https://git.openjdk.java.net/guide/pull/75