Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (19 loc) · 820 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 820 Bytes
Raw

Contributing to TFMPE

Thank you for your interest in contributing to TFMPE! This document outlines the development workflow and contribution standards.

Contribution Standards

All contributions must meet the following requirements:

  • Tests: All tests must pass (python -m pytest test/)
  • Type Checking: Code must pass static type analysis (pyright && ruff check)
  • Documentation: Include numpy-style docstrings for public APIs

Standard Contribution Process

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Ensure tests pass and type checking succeeds
  5. Submit a pull request

Development Setup

See README.md for installation and development environment setup instructions.

Questions?

Open an issue for questions about contributing or development workflow.