Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 748 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 748 Bytes

Contributing

The team welcomes contributions! To make changes:

  • Fork the repo and make a branch
  • Write your code (ideally with tests) and make sure the CircleCI build passes
  • Open a PR (optionally linking to a github issue)

Local development

We recommend using Intellij IDEA Community Edition for Java projects. You'll need Java 8 on your machine.

  1. Fork the repository
  2. Generate the IDE configuration: ./gradlew idea
  3. Import projects into Intellij: open *.ipr

Tips:

  • run ./gradlew checkstyleMain checkstyleTest locally to make sure your code conforms to the code-style.
  • run ./gradlew test -Drecreate=true to recreate all the test files if you've made a change to code generation.