From fdc95e86853bf4e67156a6230d52fff2ddb49182 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gu=C3=B0mundur=20Bj=C3=B6rn=20Birkisson?= Date: Wed, 6 Dec 2023 12:34:02 +0100 Subject: [PATCH] fix: Add pre-commit hook for conventional commits --- .pre-commit-config.yaml | 8 ++++++++ README.md | 7 +++++++ 2 files changed, 15 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..9bd65b6 --- /dev/null +++ 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 index 4a40f69..53d6c9e 100644 --- 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.