Rémi Verschelde 561a6cd503 Style: Mark clang-format 16 as supported for pre-commit hook 1 рік тому
..
README.md 561a6cd503 Style: Mark clang-format 16 as supported for pre-commit hook 10 місяців тому
canonicalize_filename.sh 80e1585a6e Style: Cleanup uses of double spaces between words 3 роки тому
pre-commit 105e8a8111 Add ability to extend the set of Git pre-commit hooks 2 роки тому
pre-commit-black a6ed4649de Make Git hooks work on worktrees on Windows 2 роки тому
pre-commit-clang-format 561a6cd503 Style: Mark clang-format 16 as supported for pre-commit hook 10 місяців тому
pre-commit-make-rst 69e90daae3 Rename "makerst.py" to "make_rst.py" 3 роки тому
winmessage.ps1 9f2c24e8ce Cleanup: Remove executable bit from files which don't need it 3 роки тому

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 make_rst: Checks the class reference syntax using make_rst.py.

Installation

Copy all the files from this folder into your .git/hooks folder, and make sure the hooks and helper scripts are executable.

Linux/MacOS

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.

Windows

clang-format
black
  • Python installation: make sure Python is added to the PATH
  • Install black - in any console: pip3 install black

Custom hooks

The pre-commit hook will run any other script in .git/hooks whose filename matches pre-commit-custom-*, after the Godot ones.