mirror of
https://github.com/godotengine/godot.git
synced 2024-12-27 11:24:59 +08:00
19 lines
682 B
Markdown
19 lines
682 B
Markdown
|
# 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.
|