From 16b47df18b3249c9bfb86230a7705a94963d552e Mon Sep 17 00:00:00 2001
From: KemoNine <mcrosson@kemonine.info>
Date: Fri, 8 Jan 2021 20:16:00 +0000
Subject: [PATCH] Add notes on how to setup commitlint+husky

---
 zmk-config/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/zmk-config/README.md b/zmk-config/README.md
index 15e36e14..afbe4eab 100644
--- a/zmk-config/README.md
+++ b/zmk-config/README.md
@@ -4,6 +4,27 @@
 
 Need to have the `zmk-config` directory mounted at `/workspaces/zmk-config` in Docker container
 
+## git commit linting setup
+
+Issue 575 on GitHub
+
+``` sh
+# cd /path/to/zmk
+npm install --save-dev @commitlint/{cli,config-conventional}
+echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
+npm install --save-dev husky@next
+npm install pinst --save-dev
+npx husky install
+npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"
+npx commitlint --from HEAD~1 --to HEAD --verbose
+touch foo
+git commit -m "foo: this will fail"
+git commit -m "chore: lint on commitmsg"
+git reset HEAD~1
+rm foo
+
+```
+
 ## Building
 
 ``` sh