Rémi Verschelde a10c259c1d Dynamically load libudev.so.1 on Linux if `udev=yes` 4 years ago
..
README.md 7b6e664178 Pre-commit hook instructions on Windows 5 years ago
canonicalize_filename.sh 0e4ee5935a clang-format: Add pre-commit hook 8 years ago
pre-commit 164826a39b Hooks: Add pre-commit hook for psf/black formatting 5 years ago
pre-commit-black 05f041127d Git Hooks: Suppress "which" error messages. 5 years ago
pre-commit-clang-format a10c259c1d Dynamically load libudev.so.1 on Linux if `udev=yes` 4 years ago
pre-commit-makerst 619354fb2c Fixed errors in makerst pre-commit hook 5 years ago
winmessage.ps1 76c6007aa6 Cleanup: Remove executable bit from files which don't need it 4 years ago

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.

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