RFR: 8332313: Update code review guidelines
Kevin Rushforth
kcr at openjdk.org
Wed May 15 18:48:31 UTC 2024
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
-------------
Commit messages:
- Update CONTRIBUTING.md and README-code-reviews.md
- 8332313: Update code review guidelines
- Convert Code Review Policies Wiki to README-code-reviews.md
Changes: https://git.openjdk.org/jfx/pull/1455/files
Webrev: https://webrevs.openjdk.org/?repo=jfx&pr=1455&range=00
Issue: https://bugs.openjdk.org/browse/JDK-8332313
Stats: 115 lines in 2 files changed: 106 ins; 0 del; 9 mod
Patch: https://git.openjdk.org/jfx/pull/1455.diff
Fetch: git fetch https://git.openjdk.org/jfx.git pull/1455/head:pull/1455
PR: https://git.openjdk.org/jfx/pull/1455
More information about the openjfx-dev
mailing list