RFR: Addition of a causes link type [v8]

Roger Calnan duke at openjdk.org
Mon Jan 27 19:28:46 UTC 2025


On Mon, 27 Jan 2025 19:15:29 GMT, Roger Calnan <duke at openjdk.org> wrote:

>> 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

done

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

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


More information about the guide-dev mailing list