RFR: 8231601: Update CONTRIBUTING.md to clarify process for contributing features plus Skara changes [v6]

Kevin Rushforth kcr at openjdk.java.net
Fri Dec 17 12:59:27 UTC 2021


On Fri, 17 Dec 2021 12:46:07 GMT, Kevin Rushforth <kcr at openjdk.org> wrote:

>> This PR updates the `CONTRIBUTING.md` guide to address the following:
>> 
>> 1. Clarify the process for adding new features / API changes, specifically that they must be discussed on the mailing list as the first step.
>> 2. Add a link to the mailing list in the section regarding contributing bug fixes.
>> 3. Remove the text about cross-linking the PR and JBS issue, and add a note that the Skara tooling takes care of this
>> 4. Remove the section about manually resolving the JBS issue, and add a note that the Skara bot automatically does this when the PR is integrated.
>> 5. Suggest the use of the "/reviewers 2" and "/csr" commands when appropriate
>> 6. Update the note regarding which JDK(s) to use.
>
> Kevin Rushforth has updated the pull request incrementally with one additional commit since the last revision:
> 
>   More review comments
>   
>   1. Renamed "Contributing to...codebase" section to "Coding style and testing guidelines", and switched that section with the "New features section"
>   2. Updated recommend JDK
>   3. Added forward reference for Draft and WIP PRs

CONTRIBUTING.md line 176:

> 174: 
> 175: Adding a new feature to OpenJFX requires us to consider what it means to support that API forever; we take compatibility seriously.
> 176: The main idea is to think in terms of "stewardship" when evolving the JavaFX API. This will require significant effort on your part.

@johanvos to address your point about maintenance, what do you think about adding a sentence here? Something like:

This will require significant effort on your part. __It begins before you submit a pull request for review, and continues after the new feature is integrated.__

We can follow this up with more detail in the code review guidelines.

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

PR: https://git.openjdk.java.net/jfx/pull/303


More information about the openjfx-dev mailing list