diff options
Diffstat (limited to 'misc/hooks/README.md')
| -rw-r--r-- | misc/hooks/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/misc/hooks/README.md b/misc/hooks/README.md new file mode 100644 index 0000000000..6ec90fcc54 --- /dev/null +++ b/misc/hooks/README.md @@ -0,0 +1,18 @@ +# Git hooks for Godot Engine + +This folder contains git hooks meant to be installed locally by Godot Engine +contributors to make sure they comply with our requirements. + +## List of hooks + +- Pre-commit hook for 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. + Should work on Linux and macOS. 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. + +## Installation + +Copy all the files from this folder into your .git/hooks folder, and make sure +the hooks and helper scripts are executable. |