Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1.61 KB
Raw

About to contribute?

We appreciate that. Do keep the following in mind:

  • Before making a significant contribution, consider discussing the outline of your solution first. This may avoid a duplication of efforts.
  • When you send a pull requests, please include tests to go along with it.
  • Want to paste some code or output? Put ``` on a line above and below your code/output. See GitHub Flavored Markdown's Fenced Code Blocks for details.

Building

Cucumber-JVM is built with Maven and includes a Maven Wrapper that will automatically download a correct version of Maven.

When building the project for the first time, run:

./mvnw install -DskipTests=true -DskipITs=true -Darchetype.test.skip=true

The cucumber-archetype modules integration tests against -SNAPSHOT versions of Cucumber. These must be installed first.

Afterward ./mvnw test or ./mvnw verify should work as expected.

Formatting Java

The source code is formatted automatically by spotless when running:

./mvnw install

To configure IntelliJ IDEA/Eclipse use the configuration files in .spotless/.

Formatting XML, Gherkin, ect

  • UTF-8 file encoding +
  • LF (UNIX) line endings +
  • 4 Space indent (no tabs) +
    • XML
    • Java
  • 2 Space indent (no tabs) +
    • Gherkin

+ These are set automatically if you use an editor/IDE that supports EditorConfig.