RFR: 8332313: Update code review guidelines

Kevin Rushforth kcr at openjdk.org
Wed May 15 18:59:06 UTC 2024


On Wed, 15 May 2024 18:05:10 GMT, Andy Goryachev <angorya at openjdk.org> wrote:

>> Update the code review guidelines for JavaFX.
>> 
>> The JavaFX [CONTRIBUTING](https://github.com/kevinrushforth/jfx/blob/8332313-contributing/CONTRIBUTING.md) guidelines includes guidance for creating, reviewing, and integrating changes to JavaFX, along with a pointer to a [Code Review Policies](https://wiki.openjdk.org/display/OpenJFX/Code+Reviews) Wiki page.
>> 
>> This PR updates these guidelines to improve the quality of reviews, with a goal of improving JavaFX and decreasing the chance of introducing a serious regression or other critical bug.
>> 
>> The source branch has three commits:
>> 1. Converts the Code Review Policies Wiki page to a [README-code-reviews.md](https://github.com/kevinrushforth/jfx/blob/8332313-contributing/README-code-reviews.md) file in the repo and updates hyperlinks to the new location.
>> 2. Update `README-code-reviews.md` with new guidelines
>> 3. Update `CONTRIBUTING.md` to highlight important requirements  (and minor changes to `README-code-reviews.md`)
>> 
>> Commit 1 is content neutral, so it might be helpful for reviewers to look at the changes starting from the second commit.
>> 
>> The updates are:
>> 
>> * In the Overview section, add a list of items for Reviewers, PR authors, and sponsoring Committers to verify prior to integration
>> * Create a "Guidelines for reviewing a PR" subsection of the Code review policies section
>> * Create a "Before you integrate or sponsor a PR" subsection of the Code review policies section
>> * Update the `CONTRIBUTING.md` page to highlight important requirements
>
> CONTRIBUTING.md line 52:
> 
>> 50: 
>> 51: * File a bug in JBS for every pull request
>> 52: 
> 
> for line 53, would it make more sense to use this link
> https://bugs.openjdk.org/projects/JDK/issues/
> ?

Whether or not that might be a better link, it's unrelated to this PR. The scope of this PR is limited to guidelines surrounding reviewing, integrating, and sponsoring PRs.

> README-code-reviews.md line 10:
> 
>> 8: 
>> 9: __Project Co-Lead__: Kevin Rushforth (kcr) <br>
>> 10: __Project Co-Lead__: Johan Vos (jvos)
> 
> There are two sets of ids - one for OpenJFX/JBS and one for Github.  This might be confusing sometimes, should we list both?

Not sure what you mean, but it doesn't seem related to this PR.

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

PR Review Comment: https://git.openjdk.org/jfx/pull/1455#discussion_r1602112407
PR Review Comment: https://git.openjdk.org/jfx/pull/1455#discussion_r1602113564


More information about the openjfx-dev mailing list