Rémi Verschelde 2ecab0491c Merge pull request #54179 from aaronfranke/make-rst 4 년 전
..
README.md 8f05e26198 Rename "makerst.py" to "make_rst.py" 4 년 전
canonicalize_filename.sh ae1702bee5 Replace HTTP links with HTTPS for sites with HTTPS versions 4 년 전
pre-commit 8f05e26198 Rename "makerst.py" to "make_rst.py" 4 년 전
pre-commit-black 05f041127d Git Hooks: Suppress "which" error messages. 5 년 전
pre-commit-clang-format 55d05565d0 clang-format: Enable `--Wno-error=unknown` for compat with older versions 4 년 전
pre-commit-make-rst 8f05e26198 Rename "makerst.py" to "make_rst.py" 4 년 전
winmessage.ps1 76c6007aa6 Cleanup: Remove executable bit from files which don't need it 4 년 전

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