Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (30 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 1.08 KB
Raw

Contributing to hhtools

Thank you for your interest in contributing. This project is in early alpha; feedback, bug reports, and pull requests are all welcome.

Development setup

git clone https://github.com/CAU-Qinghe/hhtools.git
cd hhtools
uv sync --extra all --extra dev

Run the linter:

ruff check hhtools
ruff format --check hhtools

Code style

  • Python 3.12+, ruff for linting and formatting (line-length = 100).
  • Type-annotated public APIs.
  • Every new module includes a module-level docstring.
  • User-facing documentation lives in README.md (亮点与用法) and framework.md (框架与原理).

Commit messages

Follow Conventional Commits:

feat(io): add Motion-X 322-dim adapter
fix(retarget): stabilise IK warm-start for short clips
docs: update framework.md

License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 license. Do not commit third-party datasets, SMPL weights, or other assets whose license prohibits redistribution.