aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBenjamin C Meyer <ben@meyerhome.net>2013-11-06 21:12:26 -0500
committerBenjamin C Meyer <ben@meyerhome.net>2013-11-06 21:51:19 -0500
commit4919c9095d322b2166d3200981dc5c4c2d64eeef (patch)
tree339e8101c4313af3744cd4b9e38fd8f0eb2251a5 /README
parenta7b60551d2fb4ce663f0b4fbc9b762c78c03cc8a (diff)
downloadgit-hooks-4919c9095d322b2166d3200981dc5c4c2d64eeef.tar.gz
git-hooks-4919c9095d322b2166d3200981dc5c4c2d64eeef.tar.bz2
Add the ability to remind users when committing to any repo without git-hooks.
It is easy to forget to install git-hooks in a repository you are using. A commit with no error message could both mean you don't have git-hooks installed and it can mean that you do have it installed, but your commit was perfect and there was no errors. The new option --installglobal creates a default .git template that is used by all future cloned repositories (and git init'd) that remind users that the repository doesn't have git-hooks installed. A number of projects I have been involved with used git-hooks, but founds its weakest point was that eventually someone would re-clone a repo and make commits with errors before turning git-hooks back on. Another common problem was when we had multiple git repositories and git-hooks was only installed in some of them, but not all While it would be nice to be able to use --instalglobal to automatically turn on git-hooks on every future repo eventually some git repository on github would include a hook that would email <secret stuff> back home and all you would have to do would be to clone it to activate it which would be a "bad thing", but it can pester you without harm. Signed-off-by: Benjamin C Meyer <ben@meyerhome.net>
Diffstat (limited to 'README')
-rw-r--r--README2
1 files changed, 2 insertions, 0 deletions
diff --git a/README b/README
index 6784bb1..530e5e7 100644
--- a/README
+++ b/README
@@ -9,6 +9,8 @@ Add git-hooks to your PATH environment variable so 'git hooks' can be run.
Run 'git hooks --install' Inside a git project to change that projects git hooks to use git-hooks hooks. 'git hooks --uninstall' can be run at any time to go back to the old hooks that were installed before (typically the default which does nothing).
+Run 'git hooks --installglobal' to force any new git repository or any git repository you clone to have a reminders to install git hooksi. (It can't be on by default for security reasons of course)
+
************************************
Overview