RFR: Addition of a causes link type [v3]
Roger Calnan
duke at openjdk.org
Tue Jan 21 19:43:52 UTC 2025
On Tue, 14 Jan 2025 19:40:18 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:
>> Roger Calnan has updated the pull request incrementally with one additional commit since the last revision:
>>
>> updates from feedback - restructured the section on the causes/caused by link, moving most of the text into other relevant sections of the guide
>
> src/guide/jbs-jdk-bug-system.md line 271:
>
>> 269: ‘relates to’ - there are no rules as to when or why to create a relates link apart from not duplicating an existing “duplicated by”, ‘backported by’, ‘csr for’ or ‘blocked by’ links. In general, you should link any other issue that has a bearing on the situation where you feel the related issue should be reviewed in order to have a better understanding of what is going on
>> 270:
>> 271: ‘causes’/‘caused by’ - the causes link implies a stronger relationship than relates. If an issue B is filed which can be traced back to the fix for issue A then ‘A causes B’ (or ‘B was caused by A’)
>
> Suggestion:
>
> ‘causes’/‘caused by’ - the ‘causes’ link implies a stronger relationship than ‘relates to’. If an issue 'B' is traced back to the fix for issue 'A' then ‘A causes B’ (or ‘B was caused by A’)
>
> Should it be ‘B _is_ caused by A’?
>
> In the above text about regressions, issue A and B have dumb single quotes around them. This should be consistent here, therefore I added them in the suggestion.
I think the past-tense makes sense, have added the quotes
-------------
PR Review Comment: https://git.openjdk.org/guide/pull/139#discussion_r1924275155
More information about the guide-dev
mailing list