First off, thanks for taking the time to contribute! 🎉
When contributing to this repository, please first describe the change you wish to make via an issue before making a change. For every other form of discussion use the discussions section of this repo. Please note we have a code of conduct, please follow it in all your interactions with the project.
Submit an issue using the provided template for bug reports. If the template does not fit your purpose start with a blank issue.
For bug reports, it's very important to fill in the information in the structure provided by the templates to help us analyzing the bug.
Submit an issue using the provided template for feature requests. If the template does not fit your purpose start with a blank issue but make sure the name starts with a "FEATURE" in square brackets.
If you are starting with a very vague idea instead of a concrete feature request post it in the discussions section of the repository where we can refine the idea with you and create a structured feature request from it.
Thank you for contributing your changes by opening a pull requests! To get something merged we usually require:
- ❗ Description of the changes - please follow the Conventional Commits specification as we use it to automatically generate our CHANGELOG ❗
- Quality of changes is ensured - through new or updated automated tests
- Change is related to an issue (feature request or bug report) - ideally discussed beforehand
- Well-scoped - we prefer multiple PRs, rather than a big one
- The develop branch contains the latest code, and all development should be based on this branch. Therefore, please ensure that the base branch for your pull request is set to 'develop'.