Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 2.74 KB
Raw

Project License: Eclipse Public License v1.0

  • You will only Submit Contributions where You have authored 100% of the content.
  • You will only Submit Contributions to which You have the necessary rights. This means that if You are employed You have received the necessary permissions from Your employer to make the Contributions.
  • Whatever content You Contribute will be provided under the Project License(s).

Building

Command line

You need to have Maven and a JDK (at least version 1.5) installed.

Run ./mvnw verify to build the code and run the tests

Eclipse

Maven can generate project files for Eclipse. See these instructions for details.

Coding Conventions

Formatting

See CODING_STYLE.txt for how we format our code.

How to submit a pull request

We love pull requests. Here is a quick guide:

  1. You need to have Maven and a JDK (at least version 1.5) installed.
  2. Fork the repo.
  3. Create a new branch from main.
  4. Ensure that you have a clean state by running ./mvnw verify.
  5. Add your change together with a test (tests are not needed for refactorings and documentation changes).
  6. Format your code: Import the JUnit project in Eclipse and use its formatter or apply the rules in the CODING_STYLE file manually. Only format the code you've changed; reformatting unrelated code makes it harder for us to review your changes.
  7. Run ./mvnw verify again and ensure all tests are passing.
  8. Push to your fork and submit a pull request.

Now you are waiting on us. We review your pull request and at least leave some comments.

Note that if you are thinking of providing a fix for one of the bugs or feature requests, it's usually a good idea to add a comment to the bug to make sure that there's agreement on how we should proceed.

Limitations

The JUnit team is not accepting changes to the code under the following paths:

  • src/main/java/junit
  • test/java/junit/tests/framework
  • test/java/junit/tests/extensions

The reasoning is that the JUnit team feels that our users should focus on using either the JUnit4 or JUnit5 APIs.

The team is also reluctant to accept changes that only update code from one code style to another. Generally the code in JUnit was approved by at least one person, so two people agreed that the style was reasonable.

To find other places where you can have an impact, please see the Issues tagged "up-for-grabs".