Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!
This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.
Please review our Code of Conduct. By participating, you are expected to uphold this code.
If you have any question that does not relate to a bug or a feature request, please use GitHub Discussions instead of GitHub issues.
GitHub issues
If you encounter a problem with this library or if you have a new feature you'd like to see in this project, please create a new issue.
GitHub Pull requests
Please leverage the repository's own tools to make sure the code is aligned with our standards:
- Run all check commands before submitting the PR (
type:check
,format:check
,lint:check
,test:coverage
andspell:check
) - Please commit your changes and run a
setup
command so you can actually check how would the template look like once cleaned up - Always leverage the
cz
command to create a commit. We heavily rely on this for automatic releases.