CSR FAQ Additions

[David Holmes]

Hi Adam,

Moving this to the csr-discuss mailing list.

Item 1 is useful info but not specific to the CSR process. In fact 
"Release Notes" are not AFAIK actually defined by the OpenJDK project, 
but rather are a distribution specific artefact. (Which is something 
that should probably be corrected!)

Item 2 may already be addressed by some very recent additions Joe made 
to the wiki regarding workflow diagrams:

https://wiki.openjdk.java.net/display/csr/Main

Cheers,
David

On 29/03/2019 9:51 pm, Adam Farley8 wrote:
> Hi All,
> 
> The CSR FAQ [1] is a great resource that answers a lot of important 
> questions.
> 
> On reading it, and going through a CSR myself, I've identified two 
> points that
> should be added to the FAQ (assuming they aren't detailed elsewhere, and 
> I've
> just missed them).
> 
> Here's a draft for the two additions.
> 
> ----- Addition 1: underneath "Q: What are common types of feedback for 
> the CSR to give?" -----
> Q: How do I create a release note?
> A: By following this process:
>     1) Find the parent bug for the CSR, and add the label 
> "release-note=yes".
>     2) Create a sub-task via the menu "More -> Create sub-task".
>     3) Use "Release note: " as the title, followed by a few words on the 
> nature of the change.
>     4) Fill in the rest of the sub-task with brief details on the parent 
> bug's changeset, and include the label "release-note"
>     5) Finally, seek review for the release note before closing it.
> 
> ----- Addition 2 -----
> Q: How do I progress a CSR?
> A: By gathering reviews and moving it through the states until you reach 
> "finalized" state.
>     Finalized CSRs are automatically reviewed by the CSR board, and they 
> will move it through
>     to "closed" state once an appropriate resolution has been chosen. Be 
> sure your CSR is
>     polished and ready for final assessment before moving it into 
> finalized state.
> 
> ----- End of Additions -----
> 
> Please review and comment, thanks. :)
> 
> Best Regards
> 
> Adam Farley
> IBM Runtimes
> 
> [1] https://wiki.openjdk.java.net/display/csr/CSR+FAQs
> Unless stated otherwise above:
> IBM United Kingdom Limited - Registered in England and Wales with number 
> 741598.
> Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6 3AU