From a3aa3be552c9bb946da1eb32336c01dcc35b7610 Mon Sep 17 00:00:00 2001 From: David Paz Date: Sun, 17 Jul 2022 10:49:51 +0200 Subject: [PATCH] Updated README docs Added hook to hook list in README documentation --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 411529a..3f7cf72 100644 --- a/README.md +++ b/README.md @@ -198,6 +198,20 @@ Trims trailing whitespace. - By default, this hook trims all whitespace from the ends of lines. To specify a custom set of characters to trim instead, use `args: [--chars,""]`. + +#### `prepare-commit-msg` +Allows for using a jinja2 template for formatting your commit message. +You can configure this with the following commandline options: +- `-t` / `--template ` - absolute path to the template. Default implementations exist + for right away usage. Default value: absolute path to bundled `prepare_commit_msg_append.j2` file +- `-b` / `--branch` - may be specified multiple times to exclude branches + from formatting the commit message. Think of it as a black list feature. + Default value: `main, master` +- `-p` / `--pattern` - may be specified multiple times to include branches + for formatting the commit message. Think of it as a white list feature. + Default value: `(?<=feature/).*` + + ### Deprecated / replaced hooks - `check-byte-order-marker`: instead use fix-byte-order-marker