Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 1.7 KB
Raw

About to contribute?

We appreciate that. Do keep the following in mind:

  • Before making 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.

Formatting Java

The source code is formatted automatically by spotless when running:

mvn install

To configure Intelij 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.

Building Cucumber-JVM

Cucumber-JVM is built with Maven.

mvn clean install

IDE Setup

IntelliJ IDEA

File -> Open Project -> path/to/cucumber-jvm/pom.xml

Your .feature files must be in a folder that IDEA recognises as source or test. You must also tell IDEA to copy your .feature files to your output directory:

Preferences -> Compiler -> Resource Patterns -> Add `;?*.feature`

If you are writing step definitions in a scripting language you must also add the appropriate file extension for that language as well.

Eclipse

Just load the root pom.xml