feat: enforce conventional commits

rdf-connect · Nov 11, 2024 · 8c43c1e · 8c43c1e
1 parent 714720f
commit 8c43c1e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -13,3 +13,9 @@ repos:
     hooks:
       - id: pretty-format-java
         args: [--autofix]
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.6.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [--verbose]
diff --git a/README.md b/README.md
@@ -34,6 +34,12 @@ This repository uses [`pre-commit`](https://pre-commit.com) for automatic lintin
 pre-commit install
 ```
 
+Conventional commits are enforced, but require an additional command to register the hook.
+
+```shell
+pre-commit install --hook-type commit-msg
+```
+
 ### Code Style and Formatting
 
 Due to the high amount of languages in this repository, we provide [a simple shell script](./format.sh) which formats most (if not all) files in this project. Please make sure your contributions conform to these formatters at all times.