Thanks for deciding to contribute! The following guidelines exists so contribution is easy and transparent, so we kindly request that you follow it.
- Be nice and respectful
- For any and all contributions, make sure an issue exists before submitting any pull request.
- When creating new issues, describe the issue clearly and add as much detail as possible.
- Issues will be assigned on a "first come, first served" basis.
- Commit message should follow the Conventional Commits style.
We use Github Flow, so all changes happen through pull requests
We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Run pre-commit hooks to lint and format your changes.
Report bugs using Github's issues
We use GitHub issues to track bugs. Report a bug by opening a new issue; it's that easy!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What was expected to happen
- What actually happens
By contributing, you agree that your contributions will be licensed under its MIT License.