Contribute to JaRIKo

Feedback and pull requests are very welcome!

Ask for help, feature or report a bug

Feel free to create feature request and bug report in the issues. Only make sure that your request/report is not the duplicate of an exiting issue.

Choose an issue to work on

Issues marked up-for-grabs or good first issue are supposed to be easy and isolated enough to be done by anyone having interest in contributing.

Build from source

See Development guide

Coding standard

Follow the Kotlin conventions. We have gradle tasks for code formatting, see the development guide

Open a pull request

Choose an open issue, or open one yourself.
Fork the project
Write automated tests covering the new feature or fix
Make sure the build passes (run ./gradlew check)
You could help our work of integrating your pull request by keeping it small: consider to split it in many smaller ones if necessary
Write a description
- explain what problem is solved (with a reference to an existing issue if applicable)
- help to read and understand the code changes
- point parts that requires special attention or consideration
Update documentation if necessary
- Documentation sources are in folder docs
Create your pull request, as documented here