Hugo Locurcio 5738d6ee6e Allow clang-format 12 in the pre-commit hook 4 năm trước cách đây
..
README.md ff11fdd017 Pre-commit hook instructions on Windows 5 năm trước cách đây
canonicalize_filename.sh 0e4ee5935a clang-format: Add pre-commit hook 8 năm trước cách đây
pre-commit 1ec7a73d1c Hooks: Add pre-commit hook for psf/black formatting 5 năm trước cách đây
pre-commit-black f99ead735c Git Hooks: Suppress "which" error messages. 5 năm trước cách đây
pre-commit-clang-format 5738d6ee6e Allow clang-format 12 in the pre-commit hook 4 năm trước cách đây
pre-commit-makerst d4c77e60c0 Fixed errors in makerst pre-commit hook 5 năm trước cách đây
winmessage.ps1 9f2c24e8ce Cleanup: Remove executable bit from files which don't need it 4 năm trước cách đây

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