Contributing Guidelines
Code Style
- Follow PEP 8 conventions
- Use
rufffor linting and formatting - Type hints are encouraged for public APIs
- Docstrings use Google style
Pull Request Process
- Fork the repository and create a feature branch
- Make your changes with clear, focused commits
- Add or update tests for any new functionality
- Ensure the full test suite passes:
uv run pytest - Update relevant documentation if needed
- Submit a PR with a clear description of changes
Testing Requirements
- All new features must include tests
- Aim to maintain or improve overall coverage
- Use
pytestfixtures for shared test setup - Mock external dependencies (network, filesystem) appropriately
Commit Messages
Use conventional commits style when possible:
feat:new featurefix:bug fixdocs:documentation changesrefactor:code refactoringtest:test additions or updateschore:maintenance tasks