RFR: Section on project maintenance
Ludvig Janiuk
lujaniuk at openjdk.org
Wed Sep 21 10:00:03 UTC 2022
On Wed, 21 Sep 2022 08:48:17 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:
> * New section on project maintenance
> * New infographics on push/defer during rampdown
> * Moved JDK Release Process section to follow the Release Note section
> * Minor fixes
src/guide/project-maintenance.md line 50:
> 48: Now it's time to create the PR on GitHub. Just opening the PR page in your browser will most often be enough to see a message about new code that was pushed to your personal fork, with a question if you want to create a PR. You do.
> 49:
> 50: Make sure the name of the PR starts with "Merge". You may have noticed that when you integrate a "normal" PR into an OpenJDK repository, all commits that has been done in that PR will be squashed into a single commit. For normal changes this is a good thing as each PR normally correspond to a single JBS issue, but for a merge it would be highly undesirable to squash all the different commits that you pull in from mainline. A PR with a name that starts with "Merge" won't be squashed. That means that all the changes that you brought over will remain separate changes.
Suggestion:
Make sure the name of the PR starts with "Merge". You may have noticed that when you integrate a "normal" PR into an OpenJDK repository, all commits that have been done in that PR will be squashed into a single commit. For normal changes this is a good thing as each PR normally corresponds to a single JBS issue, but for a merge it would be highly undesirable to squash all the different commits that you pull in from mainline. A PR with a name that starts with "Merge" won't be squashed. That means that all the changes that you brought over will remain separate changes.
src/guide/project-maintenance.md line 54:
> 52: Wether a merge requires a review or not is up to your project lead to decide. Many projects don't require this so the GitHub bots will allow you to push the merge as soon as the [GHA](#github-actions)s are done. (They actually allow you to push even before the GHAs are done, but that's in general not a good idea.)
> 53:
> 54: Once the PR has been integrated you can go back to your local clone and clean it up in preparation for the next merge.
I misread "clean it up" as referring to the PR. Perhaps it could say:
"Once the PR has been integrated, you can clean up your fork and its clone in preparation for the next merge."
-------------
PR: https://git.openjdk.org/guide/pull/92
More information about the guide-dev
mailing list