Add pre-commit and pre-push hook

junxie6 · Jun 22, 2022 · f458999 · f458999
1 parent 2fcd78b
commit f458999
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -134,6 +134,9 @@ install_devel:
 	$(MAKE) -C .config/python-style install_devel
 	pip3 install -e ".[devel]"
 
+install_git_hooks:
+	install -m 755 tools/pre-{commit,push} .git/hooks/
+
 upgrade_devel:
 	tools/upgrade_dependencies.py
 

diff --git a/doc/Development.md b/doc/Development.md
@@ -32,6 +32,7 @@ Make targets for common development tasks are:
 - `format` Perform automatic code formatting on Python code
 - `install_devel` Install project in editable mode
 - `upgrade_devel` Upgrade all development dependencies (note: `install_devel` must be executed before changes in `setup.py` take effect)
+- `install_git_hooks` Install git hooks for automatic checks before creating and pushing commits
 
 Additional tools can be found in `tools/`.
 

diff --git a/tools/pre-commit b/tools/pre-commit
@@ -0,0 +1,3 @@
+#!/bin/sh
+
+make check_black check_isort
diff --git a/tools/pre-push b/tools/pre-push
@@ -0,0 +1,3 @@
+#!/bin/sh
+
+make check