Contributing
To contribute to this project, follow these steps:
- Fork the repository
- Clone your fork
- Install dependencies
- Important: Install pre-commit hooks:
pre-commit install
Development Process
- Create a feature branch:
git checkout -b feature/your-feature - Make your changes
- Ensure all pre-commit hooks pass
- Push your branch and create a Pull Request
Code Quality
All code must pass: - Ruff linting and formatting - mypy type checking - pytest test suite
Run these checks locally before pushing to ensure your PR will pass CI.
Pre-commit Hooks
Pre-commit hooks are required for all contributors. They ensure: - Consistent code style - Type safety - All tests pass before pushing