Skip to content

Latest commit

 

History

History
106 lines (73 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

106 lines (73 loc) · 2.99 KB

Contributing to toon-python

Thank you for your interest in contributing to the official Python implementation of TOON!

Project Setup

This project uses uv for dependency management.

# Clone the repository
git clone https://github.com/toon-format/toon-python.git
cd toon-python

# Install dependencies (uv will create a virtual environment automatically)
uv sync

# Run tests
uv run pytest

# Run tests with coverage
uv run pytest --cov=src/toon_format --cov-report=term-missing

Development Workflow

  1. Fork the repository and create a feature branch
  2. Make your changes following the coding standards below
  3. Add tests for any new functionality
  4. Ensure all tests pass and coverage remains high
  5. Submit a pull request with a clear description

Coding Standards

Python Version Support

We support Python 3.8 and above (including Python 3.13 and 3.14).

Type Safety

  • All code must include type hints
  • Run mypy before committing: 
    uv run mypy src/

Code Style

  • We use ruff for linting and formatting
  • Run before committing: 
    uv run ruff check src/ tests/
uv run ruff format src/ tests/

Testing

  • All new features must include tests
  • Maintain test coverage at 85%+ line coverage
  • Tests should cover edge cases and spec compliance
  • Run the full test suite: 
    uv run pytest tests/

# Run with coverage report
uv run pytest --cov=toon_format --cov-report=term --cov-fail-under=85

SPEC Compliance

All implementations must comply with the TOON specification.

Before submitting changes that affect encoding/decoding behavior:

  1. Verify against the official SPEC.md
  2. Add tests for the specific spec sections you're implementing
  3. Document any spec version requirements

Pull Request Guidelines

  • Title: Use a clear, descriptive title
  • Description: Explain what changes you made and why
  • Tests: Include tests for your changes
  • Documentation: Update README or documentation if needed
  • Commits: Use clear commit messages (Conventional Commits preferred)

Your pull request will use our standard template which guides you through the required information.

Communication

  • GitHub Issues: For bug reports and feature requests
  • GitHub Discussions: For questions and general discussion
  • Pull Requests: For code reviews and implementation discussion

Maintainers

This is a collaborative project. Current maintainers:

All maintainers have equal and consensual decision-making power. For major architectural decisions, please open a discussion issue first.

License

By contributing, you agree that your contributions will be licensed under the MIT License.