mirror of https://github.com/godotengine/godot synced 2024-11-02 10:25:48 +00:00

History

Pedro J. Estébanez 8e2d0e1bb1 Add ability to extend the set of Git pre-commit hooks		2022-08-30 13:34:10 +02:00
..
canonicalize_filename.sh
pre-commit	Add ability to extend the set of Git pre-commit hooks	2022-08-30 13:34:10 +02:00
pre-commit-black
pre-commit-clang-format	Relax version warning in clang-format precommit hook	2022-05-05 13:39:28 +02:00
pre-commit-make-rst	makerst: Print colored output for easier visual grepping	2022-06-11 00:19:36 +02:00
README.md	Add ability to extend the set of Git pre-commit hooks	2022-08-30 13:34:10 +02:00
winmessage.ps1

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.

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.

Download LLVM for Windows (version 13 or later) from https://releases.llvm.org/download.html
Make sure LLVM is added to the PATH during installation

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