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

[calnan]

On Thu, 11 May 2023 22:16:18 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:

>> src/guide/jbs-jdk-bug-system.md line 77:
>> 
>>> 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.
>>> 77: * Only set [CPU]{.jbs-field} and/or [OS]{.jbs-field} fields if the bug **ONLY** happens on that particular platform or set of platforms.
>> 
>> This would be ideal but in practice very hard. Most people would set this to the platform they saw the problem on. There is very little chance they can know, or can find out, whether it only happens on that platform. The person later working on the bug can update these fields if needed, but in my experience very few people use these fields in a meaningful way.
>
> I think that's why we want people to only set it if they know. Maybe it should even more clear. My initial intention when writing that sentence was to discourage people from using those fields for that very reason that you mention - they are almost never used in the right way.

Update it to
In general the [CPU]{.jbs-field} and/or [OS]{.jbs-field} fields should not be set. **ONLY** use them if you know that the issue is only relevant to a particular platform or set of platforms.

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

PR Review Comment: https://git.openjdk.org/guide/pull/100#discussion_r1192775884