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.
This project and everyone participating in it are governed by our Code of Conduct. By participating, you are expected to uphold this code.
Review our Security Policy for information on how to report security vulnerabilities.
If you encounter a bug, please check the existing issues to see if it has already been reported. If not, please open a new issue, providing as much detail as possible, including steps to reproduce.
We welcome suggestions for new features or enhancements. Please open an issue to discuss your ideas before starting work on them.
We actively welcome your pull requests. To make the process as smooth as possible, please follow these guidelines:
- Fork the repository and create your branch from
main. - If you've added code that should be tested, add tests.
- Ensure that your code passes the existing tests.
- Make sure your code lints.
- Update the documentation to reflect any changes if necessary.
- Open a pull request, providing a clear description of your changes and referencing any related issues.
By contributing to this project, you agree that your contributions will be licensed under the project's license.