How to contribute

Contribution welcome!

How to prepare

You will need a GitHub account
Submit an issue ticket for your issue if the is no one yet.
- Describe the issue and include steps to reproduce if it's a bug.
- Ensure to mention the earliest version that you know is affected.
If you are able and want to fix this, fork the repository on GitHub

In your forked repository, create a feature branch for your upcoming patch. (e.g. feature/issue-22-enhance-four-candles or bugfix/issue-42-crash-when-laughing)
- Usually this is based on the main branch.
- Create a branch based on main;
  - git checkout main
  - git checkout -b feature/issue-22-enhance-four-candles
- Please avoid working directly on the main branch.
Make sure you stick to the coding style that is used already.
- The project uses Spotless.
- Run ./gradlew format to format the code.
Make commits of logical units and describe them properly.
Submit tests to your patch / new feature, so it can be tested easily.

Before submitting run ./gradlew format check:
- Running ./gradlew format will ensure the code is correctly formatted.
- Running ./gradlew static will run static code analysis.
- Running ./gradlew test will run all the tests.
- Running ./gradlew coverage will produce a code coverage report in <project-roo>/build/reports/jacoco/test/html/index.html>
Push your changes to a feature branch in your fork of the repository.
Open a pull request to merge the changes from your branch into the main branch.
Please reference the Github issue number in your pull request.
Ensure all checks pass on the pull request.