RFR: Updates to the JBS section of the OpenJDK Dev Guide [v7]

[calnan]

On Tue, 21 Mar 2023 03:24:08 GMT, David Holmes <dholmes at openjdk.org> wrote:

>> calnan has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Updated the definition of a regression and a few other minor updates.
>
> src/guide/jbs-jdk-bug-system.md line 53:
> 
>> 51: 
>> 52: <br>
>> 53: A few things to keep in mind when filing an issue to report a problem:
> 
> "problem" here could mean "bug" or "enhancement" depending on the nature of the problem. But some of the below relates to filing an issue for non-problems too.

removed "to repot a problem"

> src/guide/jbs-jdk-bug-system.md line 76:
> 
>> 74:     * passwords, logins, machine names
>> 75:     * logs which may include sensitive data
>> 76: * If the failure isn't reproducible with an existing OpenJDK test, attach a reproducer if possible, while in a number of cases it isn't possible, having a test case will decrease the time required to resolve the issue.
> 
> I suggest splitting this into two sentences at "while".

it has been simplified a bit:
If the failure isn't reproducible with an existing OpenJDK test, attach a reproducer if possible, having a test case will decrease the time required to resolve the issue.

> src/guide/jbs-jdk-bug-system.md line 90:
> 
>> 88: 
>> 89: ### Implementing a Large Change
>> 90: When managing the work for a large change, especially when the work involves multiple engineers, it is recommended that the work is distributed across one or more "implementation" issues which should be linked to the main [Enhancement]{.jbs-field} with a "blocks" link along with any relevant CSRs. The [Enhancement]{.jbs-field} should not be considered done until all the blocking element are completed.  The use of subTasks for [Enhancement]{.jbs}s is not recommended unless all the [Sub-task]{.jbs-field}s are relevant to the fix, if it were to be backported.
> 
> To me this is exactly what sub-tasks should be used for. ???

see latest update

> src/guide/jbs-jdk-bug-system.md line 107:
> 
>> 105: <tr>
>> 106:     <td class="dictionary">Open</td>
>> 107:     <td class="dictionary">Most straightforward issues stay in this state until they are closed.  If the issue has some attention then use "In Progress" to show more clearly that the issue is being worked</td>
> 
> If you start working on an issue then you should mark it in-progress by selecting "Work started", not just leave it "open". This gives a clear indication that the assignee is actually working on something and it isn't just one of a dozen bugs assigned to someone that they may, or may not, eventually get around to looking at.

Fair point - have updated it to:
Once the issue has been triaged it will be in the [Open]{.jbs-field} state and will stay here until the assignee decides to work on it, at which point it is encouraged that the "Start Work" option be selected to move it to [In Progress]{.jbs-field}

> src/guide/jbs-jdk-bug-system.md line 110:
> 
>> 108: </tr>
>> 109: <tr>
>> 110:     <td class="dictionary">In Progress</td>
> 
> See above.

see above...

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

PR Review Comment: https://git.openjdk.org/guide/pull/100#discussion_r1192765218
PR Review Comment: https://git.openjdk.org/guide/pull/100#discussion_r1192764409
PR Review Comment: https://git.openjdk.org/guide/pull/100#discussion_r1192762347
PR Review Comment: https://git.openjdk.org/guide/pull/100#discussion_r1192761666
PR Review Comment: https://git.openjdk.org/guide/pull/100#discussion_r1192761981