Contributing


Contributions to the project through pull requests are more then welcome. Please keep to these guidelines before issuing a pull request:

  • Create a ticket of the work you intend to do if none is present. Add the ticket number in your commit message(s).
  • Create a branch for your ticket with a descriptive name.
  • Maintain or improve code quality with your contribution. Only clean, well documented and useful code will be accepted. Stick to the well known code quality principles (DRY, YAGNI, KISS).
  • New features should be implemented in Scala first and if applicable be made available through the Java API.
  • New functionality should be accompanied by corresponding tests.
  • Changes in the public facing API should be accompanied by relevant changes in the documentation.