Thanks for your interest in contributing!
- Fork and clone the repo
- Create a virtual environment: python -m venv .venv && source .venv/bin/activate
- Install dev dependencies: pip install -e ".[dev]"
- Run tests: pytest tests/ -v
- Lint: ruff check src/
- Run ruff format src/ --check before committing
- Fork the repo and create a feature branch
- Add tests for any new functionality
- Ensure all existing tests pass
- Run ruff check src/ --fix before committing
- Keep PRs focused on a single change
- Use GitHub Issues
- Include Python version, OS, and steps to reproduce
- Include relevant error output
- Python 3.10+
- Type hints where practical
- Follow ruff defaults (Black-compatible formatting)
By contributing, you agree your work will be licensed under the same license as this project.