Skip to content

Contributing Guide

See the full Contributing Guide on GitHub.

Quick Start

  1. Fork and clone the repository
  2. Install:

    uv sync --extra dev
    
    pip install -e ".[dev]"
    
  3. Test: pytest (or uv run pytest)

  4. Submit a pull request

Key Topics

The contributing guide covers:

  • Architecture - Three-stage pipeline: Kaitai > Parsers > Models
  • Development - CLI tools, debugging tips, After Effects JSX scripts
  • Adding Features - New attributes, layer types, boolean flags
  • Testing - Running tests, creating samples
  • Code Style - Type hints, linting, documentation