Skip to content

Contributing

We welcome contributions to Voxta Twitch Relay!

Development Setup

  1. Clone the repository:

    git clone https://github.com/dion-labs/voxta-twitch-relay
    cd voxta-twitch-relay
    

  2. Install dependencies using uv:

    uv sync --all-extras
    

  3. Install pre-commit hooks:

    uv run pre-commit install
    

Running Tests

uv run pytest

Linting and Formatting

We use ruff for linting and formatting.

uv run ruff check .
uv run ruff format .

Building Documentation

uv run mkdocs serve