Rémi Verschelde 561a6cd503 Style: Mark clang-format 16 as supported for pre-commit hook | 1 year ago | |
---|---|---|
.. | ||
README.md | 10 months ago | |
canonicalize_filename.sh | 3 years ago | |
pre-commit | 2 years ago | |
pre-commit-black | 2 years ago | |
pre-commit-clang-format | 10 months ago | |
pre-commit-make-rst | 3 years ago | |
winmessage.ps1 | 3 years ago |
This folder contains Git hooks meant to be installed locally by Godot Engine contributors to make sure they comply with our requirements.
clang-format
: Applies clang-format
to the staged
files before accepting a commit; blocks the commit and generates a patch if
the style is not respected.
You may need to edit the file if your clang-format
binary is not in the
PATH
, or if you want to enable colored output with pygmentize
.black
: Applies black
to the staged Python files
before accepting a commit.make_rst
: Checks the class reference syntax using
make_rst.py
.Copy all the files from this folder into your .git/hooks
folder, and make
sure the hooks and helper scripts are executable.
The hooks rely on bash scripts and tools which should be in the system PATH
,
so they should work out of the box on Linux/macOS.
PATH
during installationPATH
black
- in any console: pip3 install black
The pre-commit hook will run any other script in .git/hooks
whose filename
matches pre-commit-custom-*
, after the Godot ones.