-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
iox-#2 Add simple README for the git-hooks
- Loading branch information
1 parent
7bf7081
commit d2af8e5
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |