RFR: 8312882: Update the CONTRIBUTING.md with pointers to lifecycle of a PR [v2]

Erik Joelsson erikj at openjdk.org
Wed Aug 9 12:36:40 UTC 2023


On Wed, 9 Aug 2023 12:18:08 GMT, Jesse Glick <duke at openjdk.org> wrote:

>> @jaikiran in https://github.com/openjdk/jdk/pull/12871#issuecomment-1612310113 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.
>
> Jesse Glick has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains four additional commits since the last revision:
> 
>  - Making `building.md` also link only to the guide
>  - Linking only to the guide, as suggested by @JesperIRL: https://github.com/openjdk/jdk/pull/14716#issuecomment-1670908305
>  - Merge branch 'master' of https://github.com/openjdk/jdk into patch-1
>  - 8312882: Update the CONTRIBUTING.md with pointers to lifecycle of a PR

I'm changing my mind and agreeing with Jesper.

CONTRIBUTING.md line 4:

> 2: 
> 3: Please see the [OpenJDK Developers’ Guide](https://openjdk.org/guide/),
> 4: especially the section [Working With Pull Requests](https://openjdk.org/guide/#life-of-a-pr).

I'm not sure about the second line. "Contributing" can mean a wide variety of things. I think we should leave it to the guide to break this down for any new user.

doc/building.md line 2035:

> 2033: you to follow our rules and guidelines to be able to accept your contribution.
> 2034: 
> 2035: The official place to start is the [OpenJDK Developers’ Guide](https://openjdk.org/guide/).

When changing this file, you also need to regenerate the `building.html`. See bottom of this file for instructions.

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

PR Review: https://git.openjdk.org/jdk/pull/14716#pullrequestreview-1569416423
PR Review Comment: https://git.openjdk.org/jdk/pull/14716#discussion_r1288391918
PR Review Comment: https://git.openjdk.org/jdk/pull/14716#discussion_r1288393679



More information about the build-dev mailing list