Skip to content

Commit

Permalink
iox-#2 Add simple README for the git-hooks
Browse files Browse the repository at this point in the history
  • Loading branch information
elBoberido committed Sep 17, 2023
1 parent 7bf7081 commit d2af8e5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions tools/git-hooks/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit d2af8e5

Please sign in to comment.