RFR: Removing a JBS Issue [v2]
Jesper Wilhelmsson
jwilhelm at openjdk.org
Wed Aug 9 15:38:58 UTC 2023
On Fri, 4 Aug 2023 19:03:23 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:
>> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
>>
>> Understand your code
>
> src/guide/jbs-jdk-bug-system.md line 250:
>
>> 248: Removing a JBS issue is a rare extreme case that shouldn't be part of the normal workflow. For this reason, removing issues is restricted to admins only. If you for some reason need to remove an issue, send an email to [ops at openjdk.org](mailto:ops at openjdk.org). You need to provide the bug id and a well thought through reason to why the issue should be removed.
>> 249:
>> 250: Note that JBS issues are not removed just because something was a bad idea, or reported an issue that turned out to be an embarassing user misstake. Such issues are simply closed.
>
> Something is missing here: “…or reported an issue…”. If you omit the previous sentence, it could be easier to spot: “…just because … [or] reported an issue…”. Is the subject of the verb “reported” missing?
>
> Does “…or a reported issue turned out to be…” sound right?
Yes, thank you! Fixed.
> src/guide/working-with-pull-requests.md line 15:
>
>> 13: ## Think once more
>> 14:
>> 15: All code reviews in OpenJDK are done in public. Once you open your PR for public review the internet can see it and comment on it. Make sure your code is ready for it. Look through your comments, make sure that temporary code is gone, and make sure you have sanitized your method and variable names. Also make sure you understand your code. Why is it working? What are the potential pitfalls? What are the edge-cases? If you haven't already in the mail conversation that preceeded this PR, it's likely that you will need to answer all these questions during the review.
>
> Suggestion:
>
> All code reviews in OpenJDK are done in public. Once you open your PR for public review the internet can see it and comment on it. Make sure your code is ready for it. Look through your comments, make sure that temporary code is gone, and make sure you have sanitized your method and variable names. Also, make sure you understand your code. Why is it working? What are the potential pitfalls? What are the edge-cases? If you haven't already answered all these questions in the mail conversation that preceded this PR, it's likely that you will need to answer them during the review.
>
> It's better not to omit the verb and its object in the conditional sentence that goes before the main one, the reader doesn't know yet about the things that are omitted.
Agreed. Thanks!
-------------
PR Review Comment: https://git.openjdk.org/guide/pull/112#discussion_r1288712102
PR Review Comment: https://git.openjdk.org/guide/pull/112#discussion_r1288712838
More information about the guide-dev
mailing list