RFR: Addition of a causes link type [v2]

[Roger Calnan]

On Wed, 4 Dec 2024 02:24:43 GMT, David Holmes <dholmes at openjdk.org> wrote:

>> Roger Calnan has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   updates from feedback
>
> src/guide/jbs-jdk-bug-system.md line 257:
> 
>> 255: ### Linking Issues
>> 256: 
>> 257: An important aspect of any issue is making clear how it is connected/related to other issues, this linking is done when closing an issue - such as marking an issue as a duplicate and [adding a duplicate link](#closing-issues-as-duplicates) or when using the ‘Create Backport’ or ‘Create CSR’ options are used which we automatically create ‘backported by’ or ‘csr for’ links (never create an issue of type Backport or CSR by hand). The other use of linking is to associate an issue with one or more other issues that share some relation with the issue and is done during the triage or resolution of the issue.
> 
> Linking can occur at any stage of an issue's lifecycle: when it is filed, when it is triaged, when it is being worked upon, or when it is being closed. Suggestion:
>> An important aspect of any issue is making clear how it is connected/related to other issues. This can occur at any stage of the issue's lifecycle. For example, as information becomes available that might suggest a cause, or similar issue; or when a Backport or CSR request is created; or when closing as a duplicate of another issue.

done
I think we may want to emphasis that backports should not be created by hand - but perhaps that should be in the backport section - I'll look at that along with your last point

> src/guide/jbs-jdk-bug-system.md line 261:
> 
>> 259: There are the following link types:
>> 260: 
>> 261: ’duplicate of` - See [Closing issues as duplicates] for more information.
> 
> Suggestion:
> 
> ’duplicate of` - Normally set automatically - see [Closing issues as duplicates] for more information.

done

> src/guide/jbs-jdk-bug-system.md line 263:
> 
>> 261: ’duplicate of` - See [Closing issues as duplicates] for more information.
>> 262: 
>> 263: ‘backported by’ - When creating a backport with the “More -> Create Backport” option a link is automatically created between the main issue and the new Backport
> 
> Suggestion:
> 
> ‘backported by’ - Normally set automatically when creating a backport with the “More -> Create Backport” option

done

> src/guide/jbs-jdk-bug-system.md line 265:
> 
>> 263: ‘backported by’ - When creating a backport with the “More -> Create Backport” option a link is automatically created between the main issue and the new Backport
>> 264: 
>> 265: ‘CSR for’ - When creating a CSR with the “More -> Create CSR” option a link is automatically created between the main issue and the new CSR
> 
> Suggestion:
> 
> ‘CSR for’ - Normally created automatically when creating a CSR with the “More -> Create CSR” option a link

done

> src/guide/jbs-jdk-bug-system.md line 267:
> 
>> 265: ‘CSR for’ - When creating a CSR with the “More -> Create CSR” option a link is automatically created between the main issue and the new CSR
>> 266: 
>> 267: ‘blocks’ - when a fix is broken down into a number of parts the ‘blocks’ link should be used to ensure they are all fixed before the main issue is considered resolved - see [implementing large changes](#implementing-large-changes]
> 
> Suggestion:
> 
> ‘blocks’ - For when other issues are dependent on the current issue being resolved/fixed before they can be. For example, when a fix is broken down into a number of parts the ‘blocks’ link should be used to ensure they are all fixed before the main issue is considered resolved - see [implementing large changes](#implementing-large-changes]

done

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

PR Review Comment: https://git.openjdk.org/guide/pull/139#discussion_r1868668650
PR Review Comment: https://git.openjdk.org/guide/pull/139#discussion_r1868669666
PR Review Comment: https://git.openjdk.org/guide/pull/139#discussion_r1868668717
PR Review Comment: https://git.openjdk.org/guide/pull/139#discussion_r1868668768
PR Review Comment: https://git.openjdk.org/guide/pull/139#discussion_r1868668907