readme
This commit is contained in:
parent
4ab65b9d5c
commit
ebb844a3fc
1 changed files with 9 additions and 0 deletions
9
README.md
Normal file
9
README.md
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
# Overview
|
||||||
|
|
||||||
|
Repo contains a git hook to check if the string `breakpoint` exists in any file you have staged for a commit. If the string does exist, it will provide a warning and not let you complete the commit. This is useful for python developers who are heavy offenders of commiting breakpoints (aka me).
|
||||||
|
|
||||||
|
# How To
|
||||||
|
|
||||||
|
1. clone this repo, preferably in ~/.config/
|
||||||
|
2. add the path to this repo to your git hooks path: `git config --global core.hooksPath ~/.config/git/hooks/`
|
||||||
|
3. that's it
|
||||||
Loading…
Reference in a new issue