godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
164826a39b
godot/misc/hooks/README.md
Rémi Verschelde 164826a39b Hooks: Add pre-commit hook for psf/black formatting
2020-03-30 09:05:59 +02:00

1.1 KiB
Raw Blame History

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. 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.
  • Pre-commit hook for black: Applies black to the staged Python files before accepting a commit.
  • Pre-commit hook for makerst: Checks the class reference syntax using makerst.py.

Installation

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, and might work on Windows when using git-bash.exe with clang-format, Python, black, etc. in the PATH.