Firstly, thank you for considering contributing to this project! Your time and effort is appreciated. 👏
You'll need to fork the repository. For more information on how to do this, check out the GitHub documentation.
Once you've made your changes, please submit a pull request. In your pull request, please include the following:
- A description of the changes you've made.
- A reference to any issues that your pull request addresses.
- Any relevant documentation or tests that you've added or updated.
- Any other information that you think is relevant to your pull request.
- If your pull request is a work in progress, please mark it as a draft pull request.
- Be sure to include an update to the
CHANGELOG.mdfile. The format is based on the Keep a Changelog specification. Within the "Unreleased" section add one or many list items under the following sub headings:Added, `Added for new features.Changedfor changes in existing functionality.Deprecatedfor soon-to-be removed features.Removedfor now removed features.Fixedfor any bug fixes.Securityin case of vulnerabilities.
- Please check for any existing issues before creating a new one. If you find an issue that is already open, please add any additional information or context that you think might be helpful.
- If you find a bug, please include a minimal reproducible example that demonstrates the issue.
- If you have a feature request, please include a description of the feature and why you think it would be useful.