Contributing
We welcome contributions! Please follow these guidelines.
Development Setup
-
Fork the repository and clone it.
-
Create a virtual environment:
python -m venv venv -
Activate it and install the package in editable mode with development extras:
bash
pip install -e ".[dev]"
- Install pre-commit hooks:
pre-commit install
Coding Standards
- Python 3.10+
- Type hints everywhere.
- Ruff for linting and formatting (
ruff check . && ruff format .). mypyfor static type checking.- 90%+ test coverage.
Testing
pytest
Pull Request Process
- Create a feature branch.
- Write tests for your changes.
- Ensure all tests pass and coverage does not decrease.
- Open a pull request against
main.
License
By contributing, you agree that your contributions will be licensed under the MIT License.