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

Lorenz Pahl github.com+12369767+lorenzpahl at openjdk.java.net
Fri Oct 2 18:57:37 UTC 2020


On Fri, 18 Sep 2020 18:57:16 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:
> 
>   Address review coments

CONTRIBUTING.md line 198:

> 196: * Avoid making changes that are unrelated to the bug you are fixing. This includes fixing minor errors such as
> warnings, spacing / indentation, spelling errors, etc, in code that you aren't otherwise modifying as part of your fix.
> 197: * Disable “auto-format on save” to prevent your IDE from making unnecessary formatting changes. This
> makes reviews much harder as it generates unnecessary diffs. If your IDE supports formatting only modified chunks, that
> is fine to do. 198: * Wildcard imports – for example, `import java.util.*;` – are forbidden and may cause
> the build to fail. Please attempt to configure your IDE so it doesn't genearte wildcard imports. An exception to this
> rule is that wildcard static imports in test classes are allowed, for example, `import static org.junit.Assert.*;`.

There is a small spelling error:  "genearte".

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

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


More information about the openjfx-dev mailing list