mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 03:18:37 +08:00
Code Issues Packages Projects Releases Wiki Activity
4d52761da6
godot/misc/hooks
History
Rémi Verschelde 4d52761da6 Hooks: Use pygmentize if available to visualize diff
2020-03-30 09:05:59 +02:00
..
canonicalize_filename.sh clang-format: Add pre-commit hook 2017-02-12 00:51:31 +01:00
pre-commit Hooks: Add pre-commit hook for psf/black formatting 2020-03-30 09:05:59 +02:00
pre-commit-black Hooks: Use pygmentize if available to visualize diff 2020-03-30 09:05:59 +02:00
pre-commit-clang-format Hooks: Use pygmentize if available to visualize diff 2020-03-30 09:05:59 +02:00
pre-commit-makerst Add a pre-commit hook to check the class reference syntax 2019-12-06 23:40:19 +01:00
README.md Hooks: Add pre-commit hook for psf/black formatting 2020-03-30 09:05:59 +02:00

README.md

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.