Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (43 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.38 KB
Raw

Contributing to temporalcv

Thank you for your interest in contributing to temporalcv!

Development Setup

# Clone the repository
git clone https://github.com/brandon-behring/temporalcv.git
cd temporalcv

# Install in development mode
pip install -e ".[dev]"

# (Optional) Install pre-commit hooks for local checks
pre-commit install

Pre-commit hooks run ruff (lint + format) and mypy (type check) before each commit. This catches issues locally before CI. If you skip this step, CI will still catch issues on push.

Running Tests

# Run all tests
pytest tests/ -v

# Run with coverage
pytest tests/ -v --cov=temporalcv --cov-report=term-missing

# Run type checking
mypy src/temporalcv

Code Style

  • We use ruff for linting and formatting (black-compatible)
  • Type hints are required on all public functions
  • Docstrings follow NumPy style

Pre-commit hooks will automatically check these before each commit.

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Make your changes
  4. Ensure all tests pass
  5. Submit a pull request

Commit Messages

Use conventional commit format:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation only
  • test: Adding tests
  • refactor: Code refactoring

Code of Conduct

Please read our Code of Conduct before contributing.