Contributing

​

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 --refresh
   

​

Development Workflows

uv pytest

ruff check . --fix
ruff format .

​

Need Help?