RFR: Addition of a causes link type [v8]

[Roger Calnan]

On Fri, 24 Jan 2025 14:40:38 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:

>> Roger Calnan has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   resolved feedback
>
> src/guide/jbs-jdk-bug-system.md line 236:
> 
>> 234:    * Enhancements that are pure cleanups: [[cleanup]{.jbs-label}](#cleanup)
>> 235:    * Project specific issues usually have their own labels as well
>> 236: 1. Managing regressions - for a bug (B) where behavior has _incorrectly_ changed from a previous fix (A) ensure that the label [[regression]{.jbs-label}](#regression) is added.  Once it is known what fix caused the regression a [caused by]{.jbs-value} link should be added to 'B' or a [causes]{.jbs-value} link to 'A'. A [causes]{.jbs-value} link would also be added to A if the fix _causes_ a change of behavior (intentional or otherwise) or it is found after integration, that additional work needs to be done. If 'A' has been identified as well as a adding a [caused by]{.jbs-value} link to that issue, set the [Introduced in Build]{.jbs-field} and [Introduced in Version]{.jbs-field} fields of 'B', based on which release 'A' was fixed in.  Do not add a [caused by]{.jbs-value} link if there was no specific product fix which _caused it_, for example, the addition of a test which finds an underlying problem should not be linked.
> 
> Suggestion:
> 
> 1. Managing regressions - for a bug (B) where behavior has _incorrectly_ changed from a previous fix (A), ensure that the label [[regression]{.jbs-label}](#regression) is added.  Once it is known what fix caused the regression a [caused by]{.jbs-value} link should be added to 'B' or a [causes]{.jbs-value} link to 'A'. A [causes]{.jbs-value} link would also be added to 'A' if the fix _causes_ a change of behavior (intentional or otherwise) or it is found after integration, that additional work needs to be done. If 'A' has been identified as well as a adding a [caused by]{.jbs-value} link to that issue, set the [Introduced in Build]{.jbs-field} and [Introduced in Version]{.jbs-field} fields of 'B', based on which release 'A' was fixed in.  Do not add a [caused by]{.jbs-value} link if there was no specific product fix which _caused it_, for example, the addition of a test which finds an underlying problem should not be linked.
> 
> 
> “If 'A' has been identified as well as” — identified as what? It looks as if something's missing…  
> Would it be better to say, “~~as well as~~ in addition to adding a [caused by]{.jbs-value} link to that issue, set the…?
> 
> This way is clearer, in my opinion.
> 
> I'd move the _Introduced in Version_ field before _Introduced in Build_ as the version is more important.

made the changes

> src/guide/jbs-jdk-bug-system.md line 271:
> 
>> 269: [relates to]{.jbs-value} - To avoid lots of relates links, the links should have some significance in relation to the cause and/or fix, for the current issue. In addition, relates links should not duplicate an existing [duplicated by]{.jbs-value}, [backported by]{.jbs-value}, [csr for]{.jbs-value} or [blocked by]{.jbs-value} link.  In particular, it may be necessary to manually remove a [relates to]{.jbs-value} link if it is later added as a [duplicated by]{.jbs-value} or [caused by]{.jbs-value} link
>> 270: 
>> 271: [causes]{.jbs-value}/[caused by]{.jbs-value} - the causes link implies a stronger relationship than relates. If an issue 'B' can be traced back to the fix for issue 'A' then ‘A causes B’ (or ‘B was caused by A’)
> 
> Suggestion:
> 
> [causes]{.jbs-value}/[caused by]{.jbs-value} - the _causes_ link implies a stronger relationship than _relates_. If an issue 'B' can be traced back to the fix for issue 'A' then ‘A causes B’ (or ‘B is caused by A’)
> 
> 
> Mark up the type of the link; use the same tense for both *‘A causes B’* and *‘B is caused by A’*.

done

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

PR Review Comment: https://git.openjdk.org/guide/pull/139#discussion_r1931065495
PR Review Comment: https://git.openjdk.org/guide/pull/139#discussion_r1931067798