ci: instruct how to set up git pre-commit hook

that runs `make precommit`. closes #368 Signed-off-by: David Xia <david@davidxia.com>
envoyproxy · Feb 19, 2025 · c8f8b8e · c8f8b8e
1 parent 5fe5e59
commit c8f8b8e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -29,6 +29,12 @@ For example, `make precommit test` will run the precommit checks and the unit te
 These are the must-run commands before you submit or pushing commits to a PR.
 If anything goes wrong, please try to run `make clean` and then run the command again.
 
+You can make `make precommit` a git pre-commit hook by moving this file.
+
+```shell
+cp pre-commit.sh .git/hooks/pre-commit
+```
+
 All test targets are prefixed with `test-*` and can be run via `make test-<target>`.
 
 Some test commands might require additional dependencies to be installed on your machine.

diff --git a/pre-commit.sh b/pre-commit.sh
@@ -0,0 +1,2 @@
+#!/bin/sh
+make precommit