Contributor Guide¶

Thank you for your interest in improving this project. This project is open-source under the MIT license and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Resources¶

Reporting Issues¶

Bug Reports¶

Use our Bug Report template which will guide you through providing: - Python version and environment details - Minimal code example to reproduce the issue - Expected vs. actual behavior - Relevant error messages and stack traces - Affected providers

Feature Requests¶

Use our Feature Request template to provide: - Clear description of the proposed feature - Problem statement and motivation - Use cases and benefits - Proposed API design with examples

Development Setup¶

Requirements: Python 3.11, 3.12, 3.13 (use pyenv for multiple versions)

# Install Python versions
pyenv install 3.11 3.12 3.13

# Install development tools
pip install uv nox

# Install package with dev dependencies
make install
# or: uv sync --all-extras --dev

Testing¶

# Run all tests
make test

# Run unit tests
make test-unit

# Run integration tests
make test-integration

# Cross-version testing
make nox

Submitting Changes¶

Requirements for acceptance:

All tests pass
Maintain 100% code coverage
Update documentation for new features
Follow code style (run make lint)

Process:

Open an issue to discuss your approach
Fork and create a feature branch
Make your changes with tests
Run make lint before committing
Open a pull request