RFR: Section on PRs [v4]

Stuart Marks smarks at openjdk.java.net
Wed Apr 13 18:51:36 UTC 2022


On Sat, 9 Apr 2022 11:15:40 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:

>> Some tips for creating pull requests.
>
> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Update src/index.md
>   
>   Co-authored-by: Daniel Jelinski <djelinski1 at gmail.com>

src/index.md line 1518:

> 1516: #. **Merge the latest changes**
> 1517: 
> 1518:    If your PR is out for review for a longer time it's a good habit to pull from the target repository regularly to keep the change up to date. This will make it easier to review the change and it will help you find issues caused by other changes sooner. If there are upstream changes that might affect your change, it's likely a good idea to rerun relevant testing as well. The GHA testing that is done automatically by GitHub should only be seen as a smoke test that finds the most severe problems with your change. It's highly unlikely that it will test your actual change in any greater detail - or even run the code that you have changed in most cases.

The phrase "pull from the target repository" is a bit vague. I guess it's intended to apply to work on a variety of different projects, not just the mainline JDK. But the common case is for the mainline JDK, so perhaps it should say something like

> Typically this involves fetching changes from the master branch of the main JDK repo, merging them into your local branch, resolving conflicts if necessary, and then pushing these changes to the PR branch. Pushing additional commits and merges into the PR branch is fine; they will be squashed into a single commit when the PR is integrated. Avoid rebasing changes, and prefer merging instead.

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

PR: https://git.openjdk.java.net/guide/pull/79


More information about the guide-dev mailing list