Skip to content

Commit

Permalink
Add explanation for the git-hook setup (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ankanna authored and pkrawat1 committed Oct 4, 2018
1 parent b092c1a commit e2fa28d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ We strongly recommend that you set up these git hooks on your machine by:
# in the project root, run:
ln -sf ../../.scripts/pre-commit .git/hooks/pre-commit
ln -sf ../../.scripts/post-commit .git/hooks/post-commit

# Yeah you read that right! Two folders up is necessary.
# See: https://stackoverflow.com/questions/4592838/symbolic-link-to-a-hook-in-git#4594681
```

> **Note that our CI will fail your PR if you dont run `mix format` in the project
Expand Down Expand Up @@ -45,3 +48,4 @@ Have fun commiting new changes! :rainbow:
[dev]: https://github.com/aviabird/snitch/tree/develop
[commit-format]: https://chris.beams.io/posts/git-commit/
[our-template]: https://github.com/aviabird/snitch/blob/develop/.git_commit_msg.txt

0 comments on commit e2fa28d

Please sign in to comment.