8312882: Update the CONTRIBUTING.md with pointers to lifecycle of a PR

[jglick]

@jaikiran in #12871 (comment) pointed me to a resource I had not previously found. https://openjdk.org/contribute is fine at a high level but still says things like

When your change is ready, send a message to the appropriate development list…

which clearly predates Skara, and does not apparently link to anything more current. Whereas this https://github.com/openjdk/jdk/blob/master/doc/building.md is thorough and discoverable, finding accurate guidelines for proposing pull requests was tough.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8312882: Update the CONTRIBUTING.md with pointers to lifecycle of a PR (Enhancement - P4)

Reviewers

• Erik Joelsson (@erikj79 - Reviewer)
• Jesper Wilhelmsson (@JesperIRL - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/14716/head:pull/14716
$ git checkout pull/14716

Update a local copy of the PR:
$ git checkout pull/14716
$ git pull https://git.openjdk.org/jdk.git pull/14716/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14716

View PR using the GUI difftool:
$ git pr show -t 14716

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/14716.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back jglick! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jglick To determine the appropriate audience for reviewing this pull request, one or more labels corresponding to different subsystems will normally be applied automatically. However, no automatic labelling rule matches the changes in this pull request. In order to have an "RFR" email sent to the correct mailing list, you will need to add one or more applicable labels manually using the /label pull request command.

Applicable Labels

• build
• client
• compiler
• core-libs
• graal
• hotspot
• hotspot-compiler
• hotspot-gc
• hotspot-jfr
• hotspot-runtime
• i18n
• ide-support
• javadoc
• jdk
• jmx
• kulla
• net
• nio
• security
• serviceability
• shenandoah

[jaikiran]

Hello Jesse, I've opened https://bugs.openjdk.org/browse/JDK-8312882 to track this change. Could you update the title of this PR to 8312882: Update the CONTRIBUTING.md with pointers to lifecycle of a PR so that it triggers the official review process?

[openjdk]

@jglick Please do not rebase or force-push to an active PR as it invalidates existing review comments. Note for future reference, the bots always squash all changes into a single commit automatically as part of the integration. See OpenJDK Developers’ Guide for more information.

[jglick]

By the way the bots seem to contradict themselves:

Commit message must refer to an issue

and a previous failing jcheck-openjdk/jdk-14716 check run referred to a commit message. Yet

Please do not rebase or force-push to an active PR

implies that there would be no way to correct a mistaken commit message! Perhaps the bot messages should be adjusted to refer to the PR title, which I think is what they are actual checking, rather than “the commit message” (which is especially ambiguous if there are multiple commits).

[jaikiran]

/label add build

[openjdk]

@jaikiran
The build label was successfully added.

[mlbridge]

Webrevs

• 04: Full - Incremental (f85f4e67)
• 03: Full - Incremental (d5e3dccf)
• 02: Full - Incremental (aa729ff8)
• 01: Full - Incremental (649736c6)
• 00: Full (15c631eb)

[dholmes-ora]

I suspect in the absence of the JBS issue in the PR title the bot/jcheck was looking for one in the commit message. Unfortunately we can't see the failed check now.

[erikj79]

By the way the bots seem to contradict themselves:

Commit message must refer to an issue

and a previous failing jcheck-openjdk/jdk-14716 check run referred to a commit message. Yet

Please do not rebase or force-push to an active PR

implies that there would be no way to correct a mistaken commit message! Perhaps the bot messages should be adjusted to refer to the PR title, which I think is what they are actual checking, rather than “the commit message” (which is especially ambiguous if there are multiple commits).

I can see how this looks confusing. Here is what's actually happening. The jcheck message "Commit message must refer to an issue" refers to the commit generated by the bot, as it would currently be integrated if the PR was integrated at that moment. For a standard PR (as in not a merge style PR) all commits in the source branch are collapsed and committed on top of the current HEAD of the target branch. The message is constructed from the PR title and other meta-data from the PR (reviewers, summary etc). So the interpretation of that message really should be "PR title must refer to an issue".

Regarding this change, I think CONTRIBUTING.md was intentionally created as just a simple link to https://openjdk.org/contribute. It would be better to update the text on openjdk.org to reflect the current practice and processes.

[jglick]

It would be better to update the text on openjdk.org to reflect the current practice and processes.

In that case shall I close this PR, and someone with permission to do so could reword JDK-8312882 to that effect?

[JesperIRL]

The official, and only up-to-date resource for how to contribute changes to the OpenJDK is the OpenJDK Developers' Guide.. It's one of the top links on the OpenJDK home page so it shouldn't be that difficult to find. One problem is of course that the CONTRIBUTING.md which is the link just before the guide refers to the slightly outdated building.md ... That's the problem that should be fixed here. The text about how to contribute in building.md should be removed as it doesn't belong in that document at all, and is wrong.

[erikj79]

I'm changing my mind and agreeing with Jesper.

[JesperIRL]

Looks good to me. I would prefer if another reviewer approves this change as well even though the bots might accept that only one reviewer approved.

[openjdk]

⚠️ @jglick the full name on your profile does not match the author name in this pull requests' HEAD commit. If this pull request gets integrated then the author name from this pull requests' HEAD commit will be used for the resulting commit. If you wish to push a new commit with a different author name, then please run the following commands in a local repository of your personal fork:

$ git checkout patch-1
$ git commit --author='Preferred Full Name <you@example.com>' --allow-empty -m 'Update full name'
$ git push

[openjdk]

@jglick This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8312882: Update the CONTRIBUTING.md with pointers to lifecycle of a PR

Reviewed-by: erikj, jwilhelm

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 1 new commit pushed to the master branch:

• 593ba2f: 8313693: Introduce an internal utility for the Damerau–Levenshtein distance calculation

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@erikj79, @JesperIRL) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

[jglick]

/integrate

[openjdk]

@jglick
Your change (at version f85f4e6) is now ready to be sponsored by a Committer.

[JesperIRL]

/sponsor

[openjdk]

Going to push as commit 42758cb.
Since your change was applied there have been 22 commits pushed to the master branch:

• 88b4e3b: 8304292: Memory leak related to ClassLoader::update_class_path_entry_list
• 6f5c903: 8313899: JVMCI exception Translation can fail in TranslatedException.
• d97de82: 8313633: [macOS] java/awt/dnd/NextDropActionTest/NextDropActionTest.java fails with java.lang.RuntimeException: wrong next drop action!
• 79be8d9: 8312259: StatusResponseManager unused code clean up
• 1875b28: 8314061: [JVMCI] DeoptimizeALot stress logic breaks deferred barriers
• bd1b942: 8313905: Checked_cast assert in CDS compare_by_loader
• 9b53251: 8313654: Test WaitNotifySuspendedVThreadTest.java timed out
• e7c83ea: 8312194: test/hotspot/jtreg/applications/ctw/modules/jdk_crypto_ec.java cannot handle empty modules
• 23fe2ec: 8313616: support loading library members on AIX in os::dll_load
• f47767f: 8313882: Fix -Wconversion warnings in runtime code
• ... and 12 more: https://git.openjdk.org/jdk/compare/360f65d7b15b327e2f160c42f318945cc6548bda...master

Your commit was automatically rebased without conflicts.

[openjdk]

@JesperIRL @jglick Pushed as commit 42758cb.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.