Skip to content

Contributing to sleap-roots

Thank you for your interest in contributing to sleap-roots!

Getting Started

See Development Setup for instructions on setting up your environment.

Development Workflow

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests and linting
  5. Submit a pull request

Code Style

  • Follow PEP 8 (enforced by Black)
  • Use Google-style docstrings
  • Add type hints to function signatures
  • Write tests for new features

See Code Style for details.

Running Tests

pytest tests/

Questions?

Open a GitHub Discussion or issue.