Merge pull request #238 from MightyCreak/chore/add-git-hooks

chore: add pre-commit git hooks to run linters

Author: MightyCreak

.githooks/pre-commit

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -e
+
+txtred='\e[0;31m'
+txtbld='\e[1m'
+txtrst='\e[0m'
+
+if ! flake8 src/ po/
+then
+    echo -e "${txtred}${txtbld}Linter error(s) from flake8${txtrst}"
+    exit 1
+fi
+
+if ! mypy src/ po/
+then
+    echo -e "${txtred}${txtbld}Linter error(s) from mypy${txtrst}"
+    exit 1
+fi

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Translation: update Portuguese translation (@hugok79)
 - Translation: add 'nl' in LINGUAS (@hugok79)
 - Update pypi packages (@MightyCreak)
+- Add pre-commit git hooks to run linters (@MightyCreak)
 
 ## 0.9.0 - 2024-01-13
 

docs/developers/developers-setup.md

@@ -10,6 +10,16 @@ Diffuse depends on these projects:
 * Meson
 * Flatpak and Flatpak builder (Linux only)
 
+### Install git hooks (optional)
+
+There is a pre-commit git hook that runs some linters on the source code before committing.
+
+To install the git hooks (for the repository only), run this command:
+
+```sh
+git config --local core.hooksPath ./.githooks
+```
+
 ## Install the dependencies
 
 ### Install the system dependencies