aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2022-08-09 14:58:24 +0200
committerGitHub <[email protected]>2022-08-09 14:58:24 +0200
commit29b295e8b0dda3e67acbb90a18200ff36cc37da0 (patch)
treea4aa06ec2541cf07248437829389e2cd94bb67ac
parentclang-format fix (diff)
downloadzen-29b295e8b0dda3e67acbb90a18200ff36cc37da0.tar.xz
zen-29b295e8b0dda3e67acbb90a18200ff36cc37da0.zip
Update CODING.md
-rw-r--r--CODING.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/CODING.md b/CODING.md
index ddb46139a..4b7423004 100644
--- a/CODING.md
+++ b/CODING.md
@@ -16,6 +16,8 @@ Those who are familiar with the UE coding standards will note that we do not req
To ensure consistent formatting we rely on `clang-format` to automatically format source code. This leads to consistent formatting which should lead to less surprises and more straightforward merging.
Formatting is ensured by using [pre-commit](https://pre-commit.com/)
+
+- [Ensure you have a Python install](https://www.python.org/downloads/) and that Python has been added to the PATH environment variable
- [Install pre-commit](https://pre-commit.com/#installation) so it is available in PATH
- Run pre-commit manually on staged files `pre-commit run`
- Run pre-commit manually on all files `pre-commit run --all-files`