zoriya/zmk
1
0
Fork 0
mirror of https://github.com/zoriya/zmk.git synced 2026-05-22 06:48:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: Add gitlint and document commit conventions

Browse Source 
* Add gitlint to pre-commit setup
* Update pre-commit setup for installing commit-hooks
* Add "Commit Conventions" contributing docs

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
Peter Johanson
2024-11-08 12:53:33 -07:00
committed by Pete Johanson
parent b0f5789b12
commit 14c6fb74ee
5 changed files with 218 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/development/local-toolchain/pre-commit.md
+3 -1
View File
@@ -22,12 +22,14 @@ Now that pre-commit is installed on your PC, you need to install it into the ZMK
```bash
pre-commit install
pre-commit install --hook-type commit-msg
```
This should print a message such as
```
pre-commit installed at .git\hooks\pre-commit
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/commit-msg
```
Pre-commit will now automatically check your changes whenever you run `git commit`. If it detects a problem, it will describe the problem and cancel the commit. For simple problems such as incorrect formatting, it will also automatically fix the files so you can just `git add` them and try again.