RFR: New section Making a change [v2]
David Holmes
dholmes at openjdk.org
Tue Jul 9 00:59:43 UTC 2024
On Mon, 8 Jul 2024 23:53:54 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:
>> The old section "Fixing a bug" was mostly outdated so it has been replaced with a section "Making a change" that holds content relevant to working with the source code and making changes. The still relevant parts of Fixing a bug has been moved to the appropriate places.
>>
>> Another change that followed from this was the new section "Responsibilities of a Reviewer".
>
> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
>
> Removed todo entry for the CSR section
src/guide/making-a-change.md line 65:
> 63: This header has two copyright notices at the top (Oracle and SAP SE) and below them the license text.
> 64:
> 65: As stated in the header, don't make changes to the copyright notices or the license text below them. If your affiliation has a copyright notice at the top of the header, consult your legal representative on how to update it. If your affiliation doesn't have a copyright notice, again consult your legal representative to see if you should add one. Do not update a copyright notice if you don't belong to that affiliation.
In relation to the last sentence we always ask that the Oracle copyright year gets updated when a change is made, regardless of who is making the change. Conversely a reviewer affiliated with a non-Oracle copyright can also request that an author update it.
src/guide/reviewing-and-sponsoring-a-change.md line 11:
> 9: Two of the most important contributions you can make in the OpenJDK community are to review and sponsor changes for other developers. All changes needs to be reviewed. Many changes even need to be reviewed by more than one person. This means that in order to enable a fast-pased development experience, all developers need to review more changes then they produce themself.
> 10:
> 11: If you are new to an area, reviewing changes is also a great way to learn the code and see what general styles and types of changes that are relevant in the area. Be mindful though, if you don't know the area well you should state this in your review comments.
s/changes that are/changes are/
src/guide/reviewing-and-sponsoring-a-change.md line 21:
> 19: ## Responsibilities of a Reviewer
> 20:
> 21: As a [Reviewer](https://openjdk.org/bylaws#reviewer) you have a responsibility to make sure changes are sound and aline with the general direction of the area. If you, as a [Reviever](https://openjdk.org/bylaws#reviewer), review a change in an area that you don't know well you probably shouldn't be the one to approve the change.
s/aline/align/
-------------
PR Review Comment: https://git.openjdk.org/guide/pull/131#discussion_r1669499928
PR Review Comment: https://git.openjdk.org/guide/pull/131#discussion_r1669500563
PR Review Comment: https://git.openjdk.org/guide/pull/131#discussion_r1669500761
More information about the guide-dev
mailing list