Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 1.53 KB
Raw

Contributing

Contributions are very welcome. There are different ways you can contribute:

  1. Improve the documentation
    • The JGiven documentation is written in AsciiDoc and is located in the docs folder.
  2. Fix/implement known issues
    • Issues with the label help wanted would be the ideal candidate for that.
  3. Come up with new ideas for improving JGiven
    • If you have an idea how JGiven can be improved, just open a new issue and describe your idea.
  4. Report bugs
    • If you find a bug in JGiven, please open a new issue.

If you want to contribute code or documentation please follow the following workflow:

  1. Fork the project
  2. Create a new feature branch with your contribution (not needed for documentation improvements)
  3. Implement your great new feature or bug fix
  4. Provide a DCO for your contribution
  5. Create a pull request

System Requirements

  • JDK 11 (JAVA_HOME and PATH should be set accordingly)
  • Gradle (is automatically downloaded by the gradlew script)
  • Android SDK if you want to build the jgiven-android module
    • Setting ANDROID_SDK_ROOT and ANDROID=true env variables is required

Building and Testing JGiven

After you have cloned the Git repository execute the following command to build and test JGiven:

./gradlew test

Code Formatting

Please follow the code format of existing code. Do never reformat a file! You can ensure the correct code formatting by using the provided checkstyle formatting file ./checkstyle.xml