We appreciate that. But before you do, please learn our basic rules:
- This is not a support or discussion forum. If you have a question, please ask it on The Cukes Google Group.
- Do you have a feature request? Then don't expect it to be implemented unless you or someone else sends a pull request.
- Reporting a bug? We need to know what java/ruby/node.js etc. runtime you have, and what jar/gem/npm package versions you are using. Bugs with pull requests get fixed quicker. Some bugs may never be fixed.
- You have to tell us how to reproduce a bug. Bonus point for a pull request with a failing test that reproduces the bug.
- Want to paste some code or output? Put ``` on a line above and below your code/output. See GFM's Fenced Code Blocks for details.
- We love pull requests, but if you don't have a test to go with it we probably won't merge it.
Cucumber-JVM is built with Maven.
mvn clean install
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.
Just load the root pom.xml
To hack on Cucumber-JVM you need a JDK, Maven and Git to get the code. You also need to set your IDE/text editor to use:
- UTF-8 file encoding
- LF (UNIX) line endings
- No wildcard imports
- Curly brace on same line as block
- 4 Space indent (no tabs)
- Java
- XML
- 2 Space indent (no tabs)
- Gherkin
Please do not add @author tags - this project embraces collective code ownership. If you want to know who wrote some code, look in git. When you are done, send a pull request. If we get a pull request where an entire file is changed because of insignificant whitespace changes we cannot see what you have changed, and your contribution might get rejected.
Below are some common problems you might encounter while hacking on Cucumber-JVM - and solutions.
This can be solved by changing the Compiler settings: Preferences -> Compiler -> Java Compiler
:
- Use compiler:
Javac
- Additional command line parameters:
-target 1.6 -source 1.6 -encoding UTF-8
Note that even though development is sometimes easier to do with 1.6, releasing should be done with 1.7.
First, make sure everything builds. Including Android.
Then, see if you can upgrade any dependencies:
mvn versions:display-dependency-updates
This is a reminder to the developers:
Then, make sure you have the proper keys set up - in your ~/.m2/settings.xml
- for example:
<settings>
<servers>
<server>
<id>cukes.info</id>
<username>yourcukesinfouser</username>
<privateKey>fullkeypath</privateKey>
</server>
<!-- See https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide -->
<server>
<id>sonatype-nexus-snapshots</id>
<username>yoursonatypeuser</username>
<password>TOPSECRET</password>
</server>
<server>
<id>sonatype-nexus-staging</id>
<username>yoursonatypeuser</username>
<password>TOPSECRET</password>
</server>
</servers>
</settings>
Replace version numbers in:
- examples/java-gradle/build.gradle
- examples/android/android-studio/Cukeulator/app/build.gradle
- examples/clojure_cukes/project.clj
- History.md
Make sure you can generate Javadocs for all modules, or else the release will fail:
mvn javadoc:javadoc
Run git commit -am "Release X.Y.Z"
Now release everything:
mvn release:clean
mvn --batch-mode -P release-sign-artifacts release:prepare -DautoVersionSubmodules=true -DdevelopmentVersion=1.1.5-SNAPSHOT
mvn -P release-sign-artifacts release:perform
Post release the API docs must be generated for each module and manually copied over to a working copy of the cucumber.github.com which must be a sibling of cucumber-jvm
(this repo):
./doc/genapi.sh
After that's done, commit and push cucumber.github.com
Now, update the dependency in example projects:
Code coverage is collected mainly to identify code that can be deleted or needs to be tested better. To generate a report, run:
COBERTURA_HOME=/some/where ./cobertura.sh
This technique to collect coverage for a multi-module Maven project is based on a blog post by Thomas Sundberg.