aboutsummaryrefslogtreecommitdiff
path: root/docs/CODING.md
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2024-02-07 13:26:23 +0100
committerStefan Boberg <[email protected]>2024-02-07 13:26:23 +0100
commitf7b0dc917dd51a981141833fb605ec6e8b7e6947 (patch)
tree671e338a7e587dcafd941643f4e8b0728993c24d /docs/CODING.md
parentAdd testcase and fix for ASIO ipv4 localhost support (#649) (diff)
downloadzen-5.4.1-pre2.tar.xz
zen-5.4.1-pre2.zip
minor docs updatesv5.4.1-pre3v5.4.1-pre2
Diffstat (limited to 'docs/CODING.md')
-rw-r--r--docs/CODING.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/CODING.md b/docs/CODING.md
index c4be7906c..2452e6ef0 100644
--- a/docs/CODING.md
+++ b/docs/CODING.md
@@ -20,5 +20,5 @@ 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`
+- Run pre-commit manually on all files `pre-commit run --all-files`. There is also a `xmake precommit` shortcut which may be easier to remember
- Install git commit hooks `pre-commit install`, which will automatically run before every commit.