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. Please note we have a code of conduct, please follow it in all your interactions with the project.
Submit a bug report 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 a feature request 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:
- The pull request should successfully clear existing tests and introduce new tests if needed. Further details about the project's testing methodology can be found here.
- ❗ Description of the changes - please follow the Conventional Commits specification as we use it to automatically generate our CHANGELOG ❗This repository has a githook to ensure the use of conventional commits. To configure it run this command on the root of the project before creating your first commit:
make init
- 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