2017-02-11 23:51:14 +00:00
|
|
|
# Git hooks for Godot Engine
|
|
|
|
|
|
2019-12-06 22:35:43 +00:00
|
|
|
This folder contains Git hooks meant to be installed locally by Godot Engine
|
2017-02-11 23:51:14 +00:00
|
|
|
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
|
2019-12-06 22:35:43 +00:00
|
|
|
clang-format binary is not in the `$PATH`, or if you want to enable colored
|
2017-02-11 23:51:14 +00:00
|
|
|
output with pygmentize.
|
2019-12-06 22:35:43 +00:00
|
|
|
- Pre-commit hook for makerst: Checks the class reference syntax using `makerst.py`.
|
|
|
|
|
Should work on Linux and macOS.
|
2017-02-11 23:51:14 +00:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2019-12-06 22:35:43 +00:00
|
|
|
Copy all the files from this folder into your `.git/hooks` folder, and make sure
|
2017-02-11 23:51:14 +00:00
|
|
|
the hooks and helper scripts are executable.
|
