We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
We Use Github Flow, So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase.
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints and formats correctly.
- Clone the repository.
- Install dependencies:
pip install -e .andpip install ruff pytest. - Run tests:
pytest. - Run linter:
ruff check . - Run formatter:
ruff format .
By contributing, you agree that your contributions will be licensed under its MIT License.