Contributing

Contributions are welcome. For code changes, please follow the development and testing checklist below before opening a pull request.

Development Setup

  1. Fork the repository on GitHub

  2. Clone your fork locally

  3. Create a development branch

  4. Install in development mode:

    pip install -e ".[dev]"
    
  5. Make your changes

  6. Run tests to ensure everything works

  7. Submit a pull request

Testing Your Changes

Before submitting:

# Run all tests
python -m pytest tests/ -v

# Check linting and formatting
ruff check .
ruff format --check .

Documentation Updates

If you make changes that affect the documentation:

sphinx-build -b html docs docs/_build/html