From e92d735b831cd146be6b1b8950fedde510385a9e Mon Sep 17 00:00:00 2001 From: Mathias Kraus Date: Wed, 23 Aug 2023 16:17:16 +0200 Subject: [PATCH] iox-#2 Add simple README for the git-hooks --- tools/git-hooks/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 tools/git-hooks/README.md diff --git a/tools/git-hooks/README.md b/tools/git-hooks/README.md new file mode 100644 index 0000000..e6b5eed --- /dev/null +++ b/tools/git-hooks/README.md @@ -0,0 +1,16 @@ +# Git Hooks for iceoryx-rs + +The provided hooks add the github issue number to the commit message +and check for trailing whitespaces and code style violations with `cargo fmt`. + +## Installation + +The hooks are active when you add the `git-hooks` directory as hooks folder to +your local project git config: + +```bash +git config core.hooksPath tools/git-hooks/ +``` + +With that you will also receive the updates of the git hooks in the future. +We recommend doing this in every new clone you did on iceoryx-rs.