RFR: Removing a JBS Issue [v5]

Alexey Ivanov aivanov at openjdk.org
Thu Aug 10 18:57:01 UTC 2023


On Wed, 9 Aug 2023 22:33:58 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:

>> Short note on removing JBS issues.
>> And adding back a lost parenthesis.
>> Added text about understanding the code before creating a PR.
>
> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Considered

src/guide/jbs-jdk-bug-system.md line 248:

> 246: ## Removing an issue
> 247: 
> 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 considered reason to why the issue should be removed.

Suggestion:

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 considered reason why the issue should be removed.

Is _‘to’_ necessary before _‘why’_?

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

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.

Should we add a comma to separate the sentences?

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

PR Review Comment: https://git.openjdk.org/guide/pull/112#discussion_r1290550029
PR Review Comment: https://git.openjdk.org/guide/pull/112#discussion_r1290553500


More information about the guide-dev mailing list