Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (47 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

71 lines (47 loc) · 2.86 KB

Contributing

JUnit Contributor License Agreement

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

Commit Messages

As a general rule, the style and formatting of commit messages should follow the guidelines in How to Write a Git Commit Message.

Pull Requests

Please add the following lines to your pull request description:

---

I hereby agree to the terms of the JUnit Contributor License Agreement.

Coding Conventions

Formatting

Code formatting is enforced using the Spotless Gradle plugin. You can use gradle spotlessApply to format new code and add missing license headers to source files. Formatter settings for Eclipse are available in the repository. For IntelliJ IDEA there's a plugin you can use.

Text in *.adoc and *.md files should be wrapped at 90 characters whenever technically possible.

Javadoc

  • Javadoc comments should be wrapped after 80 characters whenever possible.
  • This first paragraph must be a single, concise sentence that ends with a period (".").
  • Place <p> on the same line as the first line in a new paragraph and precede <p> with a blank line.
  • Insert a blank line before at-clauses/tags.
  • Favor {@code foo} over <code>foo</code>.
  • Favor literals (e.g., {@literal @}) over HTML entities.
  • Use @since 5.0 instead of @since 5.0.0.
  • Do not use @authortags. Instead, contributors will be listed on the website and in release notes.

Tests

Naming

  • All test classes must end with a Tests suffix.
  • Example test classes that should not be picked up by the build must end with a TestCase suffix.

Assertions

  • Use org.junit.jupiter.api.Assertions wherever possible.
  • Use AssertJ when richer assertions are needed.
  • Do not use org.junit.Assert or junit.framework.Assert.

Mocking

  • Use either Mockito or hand-written test doubles.

Logging

  • Use sparingly
  • Do not log in utility classes (junit-platform-commons)
  • Levels
    • SEVERE (Log4J: ERROR): extra information (in addition to an Exception) about errors that will halt execution
    • WARNING (Log4J: WARN): potential usage errors that should not halt execution
    • INFO: stuff the users might want to know but not by default (Example: ServiceLoaderTestEngineRegistry logs IDs of discovered engines)
    • FINE (Log4J: DEBUG)
    • FINER (Log4J: TRACE)