diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..2a6d56cb --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,8 @@ +repos: + - repo: https://github.com/pre-commit/mirrors-clang-format + rev: v22.1.3 + hooks: + - id: clang-format + name: clang-format (C++) + files: ^src/.*\.(?:cpp|h|inc)$ + types: [file] diff --git a/README.md b/README.md index 429b9953..a9f805ea 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,17 @@ Code contributions should be focused, build successfully on Windows, and include where practical. Because KytyPS5 is still evolving quickly, consider opening an issue before starting a large change. +### Formatting + +Set up the clang-format hook after cloning: + +```powershell +python -m pip install pre-commit +python -m pre_commit install --install-hooks +``` + +It formats staged `.cpp`, `.h`, and `.inc` files in `src`. + ## Developer Information The PS5 graphics architecture is based on AMD RDNA 2. Use AMD's