We welcome any and all contributions to this project. By participating in the project, you are expected to agree to the code of conduct.
If you have any problems using the project, check the list of existing issues. If your problem has not already been reported, please file an issue. Any potential security vulnerabilities should be reported privately.
If you want to make a contribution to the project, create a fork and make a pull request.
All code should aim to follow the Scala Style Guide.
While it is not necessary to change existing code simply to follow the style guide, if non-conforming code is changed for functional reasons, it should be updated to follow the style guide.
Most style rules can be applied using sbt 'scalafmt; Test / scalafmt'
.
Any new code should aim to include tests which cover as much of the code as possible.
Any bug fixes should include test case which demonstrates that the bug is fixed.
Any contributors must agree to the Developer Certificate of Origin.
This sign-off will happen automatically for commits created on GitHub or can be added via the git
command line using the -s
or --signoff
option.