RFR: Addition of a causes link type [v8]

Roger Calnan duke at openjdk.org
Mon Jan 27 16:27:18 UTC 2025


On Fri, 24 Jan 2025 14:49:20 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 269:
> 
>> 267: [blocks]{.jbs-value} - 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]{.jbs-value} link should be used to ensure they are all fixed before the main issue is considered resolved - see [implementing large changes](#implementing-large-changes]
>> 268: 
>> 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
> 
> Suggestion:
> 
> [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
> 
> 
> The comma in the end of the first sentence is not need, is it?
> 
> Should “relates links” be replaced with “relates to links” in the first two sentences? An italics could be used to mark them up to make it clear that these words refer to a type of the link.

the comma is fine, updated the first relates

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

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


More information about the guide-dev mailing list