Contributing

Help us improve HUD

We welcome contributions to the HUD SDK!

GitHub Repository

Fork the repo and submit a PR

Quick Start

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

Development Workflows

1. Run Tests

   uv pytest
   
2. Lint & Format

   ruff check . --fix
   ruff format .
   

Need Help?

Open an Issue

Report bugs or request features

Join Discord

Chat with the team