fix: Add pre-commit hook for conventional commits

gbbirkisson · Dec 6, 2023 · fdc95e8 · fdc95e8
1 parent ffc8904
commit fdc95e8
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,8 @@
+---
+repos:
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.0.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: []
diff --git a/README.md b/README.md
@@ -43,6 +43,7 @@ If this project is just what you needed and/or has been helpful to you, please c
 * [Release notes](#release-notes)
 * [Development](#development)
     * [Setup dependencies](#setup-dependencies)
+    * [Install pre-commit hooks](#install-pre-commit-hooks)
     * [Get some test media](#get-some-test-media)
     * [Running](#running)
 
@@ -109,6 +110,12 @@ This project uses [release-please](https://github.com/googleapis/release-please)
 $ make setup
 ```
 
+### Install pre-commit hooks
+
+```console
+$ pre-commit install --hook-type commit-msg
+```
+
 ### Get some test media
 
 I leave it up do you to put some images/videos in the `./dev/api/media` folder.