CONTRIBUTING.md

How to contribute

Thank you for your willingness to help with this project. Although we are happy with all the help, we do want to set some guidelines on how to contribute to this project. By following these guidelines you can help us to manage our time and spend more time on developing this open source project.

Do you have a question?

• Questions can be asked via GitHub discussions.
• Please ensure the question is not already asked, by searching all discussions.

Did you find a bug?

• Please make sure the bug is not already reported.
• Not sure if it is really a bug? Ask a question first. Questions will be converted to bugs if necessary.
• Please open a GitHub issue.
• Add a clear title and description.
• If possible include a simple unit test describing the bug. A few lines of code will say a lot more than a few paragraphs of text.
• If you need the fix urgently, please consider creating a Pull Request with the fix.

Did you write a patch to fix a bug?

• Please open a Pull Request with the patch.
• Link the issue to the Pull Request.
• Ensure the description clearly describes the problem and solution.
• Make sure there is a test that proves that the issue did exists and is now fixed.

Did you write a patch to fix code style issues?

Please do not submit a Pull Request, a Pull Request with only code style fixes will make it harder to track who made certain changes.

Did you want to refactor code to make it more readable and better maintainable?

• Please open a GitHub discussion to discuss it.
• Clearly describe what you want to refactor and why.
• Did you forget to open an issue? Please describe the reasoning in the Pull Request itself. But be advised that this could mean that you spend time refactoring and we still reject the Pull Request.

Do you have great ideas for the project?

• Please open a GitHub issue or discussion to discuss it.
• Do not open a Pull Request before discussing it.