> ## Documentation Index
> Fetch the complete documentation index at: https://hud-f5fd7c15-lukass-phys-experimental.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Contributing

> Contribute to the HUD Python SDK: fork the repo, set up a dev environment with uv, run tests and ruff, and open a pull request against the main branch.

We welcome contributions to the HUD SDK!

<Card title="GitHub Repository" icon="github" href="https://github.com/hud-evals/hud-python">
  Fork the repo and submit a PR
</Card>

## Quick Start

1. **Fork the repository** on GitHub.
2. **Clone your fork**:
   ```bash theme={"dark"}
   git clone https://github.com/YOUR-USERNAME/hud-python
   cd hud-python
   ```
3. **Install in development mode**:
   ```bash theme={"dark"}
   uv pip install -e ".[dev]"
   uv tool install --force --from "." hud --refresh
   ```

## Development Workflows

<Steps>
  <Step title="Run Tests">
    ```bash theme={"dark"}
    uv pytest
    ```
  </Step>

  <Step title="Lint & Format">
    ```bash theme={"dark"}
    ruff check . --fix
    ruff format .
    ```
  </Step>
</Steps>

## Need Help?

<CardGroup cols={2}>
  <Card title="Open an Issue" icon="circle-exclamation" href="https://github.com/hud-evals/hud-python/issues">
    Report bugs or request features
  </Card>

  <Card title="Join Discord" icon="discord" href="https://discord.gg/wkjtmHYYjm">
    Chat with the team
  </Card>
</CardGroup>