RFR: Section on project maintenance [v3]

[Jesper Wilhelmsson]

On Wed, 21 Sep 2022 09:02:06 GMT, Ludvig Janiuk <lujaniuk at openjdk.org> wrote:

>> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Update after Ludvig's review
>
> src/guide/project-maintenance.md line 3:
> 
>> 1: # Project Maintenance
>> 2: 
>> 3: Many OpenJDK projects build on top of the JDK source code. When doing this there are a number of common workflows that are dealt with by most project maintainers. For instance updating the code (merging) to bring in the latest changes from the upstream JDK project.
> 
>> Many OpenJDK projects build on top of the JDK source code
> 
> Examples would make this more readable for someone less experienced.

I agree that a few examples could make it slightly easier to read but I also worry that these examples will rot going forward as the example projects are completed and forgotten. How important would you say this is?

> 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."

Done.

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

PR: https://git.openjdk.org/guide/pull/92