CONTRIBUTING.md

Contributing

Thanks for your interest! This is a personal portfolio project, but issues and pull requests are welcome.

Development setup

python -m venv .venv
source .venv/bin/activate        # Windows: .venv\Scripts\activate
pip install -r requirements.txt
pip install -e .                 # editable install so `handctrl` is importable

Project layout

• src/handctrl/ — the importable package (core + demos).
• models/ — third-party MuJoCo models; do not edit (keep upstream licenses intact).
• docs/ — documentation and demo media.

Guidelines

• Keep MediaPipe-specific code inside HandTracker and rendering inside MujocoViewer; demos should stay thin.
• Resolve actuators by name and clamp commands to ctrlrange.
• Format with black, lint with ruff, and add a docstring to new public functions.
• If you change gesture logic, add/adjust a unit test (the classification functions are pure and easy to test with synthetic landmarks).