RFR: Section on PRs [v2]
Julia Boes
jboes at openjdk.java.net
Fri Apr 8 12:20:03 UTC 2022
On Wed, 6 Apr 2022 19:25:48 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:
>
> Added sentence about keeping PR up to date
A good addition to the Developer's Guide.
One idea: Could a link to this section be added to the pre-populated text in the description field of a PR or some other prominent place in the PR cretation flow? For example, the Visual Studio Code repo [1] has an info box on their PR page.
[1] https://github.com/microsoft/vscode/pulls
src/index.md line 1477:
> 1475:
> 1476: The bots will make an attempt to include the groups that need to review your change based on the location of the source code you have changed. There may be aspects of your change that are relevant to other groups as well, and the mapping from source to groups isn't always perfect, so make sure all relevant groups have been included, and add new labels using [`/label`](https://wiki.openjdk.java.net/display/SKARA/Pull+Request+Commands#PullRequestCommands-/label) if needed.
> 1477:
Equally, there should be a sentence or two on splitting a change that touches many different areas in to smaller PRs, to make life easier for reviewers. Maybe something along these lines:
#. **Make sure the PR is reviewable**
There are changes that span across several areas, for example certain typo fixes or the introduction of a new langauge feature in existing code. Accordingly, the number of lines of code touched can be quite large, which makes it harder to review the entire PR. In this case, it makes sense to split the change into several PRs, most commonly by grouping them by module.
-------------
PR: https://git.openjdk.java.net/guide/pull/79
More information about the guide-dev
mailing list