Thanks for your interest in contributing! 🎉
We use pre-commit to enforce formatting and basic repository checks (e.g., trailing whitespace, EOF fixes, clang-format).
Please run hooks locally before opening a PR:
- Install pre-commit:
pip install pre-commit - Install the git hooks in your repo:
pre-commit install - Run all hooks across the repo to verify and auto-fix issues:
pre-commit run --all-files
If CI fails because hooks made auto-fixes, run the command above, review the changes, commit them, and push again.
If you see warnings about deprecated stages in pre-commit hooks (e.g. commit, push), update the affected hook repo:
pre-commit autoupdate --repo https://github.com/pre-commit/pre-commit-hooks
(Repeat for other repos listed in .pre-commit-config.yaml if necessary.)
If you want a different formatting convention (spacing around pointers, template keyword), open an issue or PR to discuss changes to .clang-format.