From 8c43c1e40e89be8cb3789ef91417eaa4a907e53f Mon Sep 17 00:00:00 2001 From: Jens Pots Date: Mon, 11 Nov 2024 16:50:24 +0100 Subject: [PATCH] feat: enforce conventional commits --- .pre-commit-config.yaml | 6 ++++++ README.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index eeb2a1d..6fc4abe 100644 --- 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 index d5626ac..66bc7f6 100644 --- 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.