commit_hookr 0.1.5 → 0.1.6

data/README.rdoc

@@ -1,6 +1,8 @@
 = commit_hookr
 
-Configurable Git commit hooks for your team. Currently comes only with a Codebase commit menu.
+Git commit-msg hook templates for your team. Currently comes only with a hook template for an interactive commit menu, because that's what we needed it for.
+
+commit_hookr makes it easy to enforce commit message policies. We use it to make sure we don't forget to add our Codebase ticket numbers and times to the commit message. As the hook itself is checked into the project repository, it's automatically updated for all team members after their next pull when you change something.
 
 == Usage
 
@@ -10,11 +12,21 @@ Configurable Git commit hooks for your team. Currently comes only with a Codebas
     
 2. In your Git project's root:
 
-    hookr codebase
+    hookr init codebase
     
 3. Edit .hookr to your liking. If you want to use Codebase ticket listing, you need to configure the codebase project name.
 
-4. Never forget to put ticket ids and time in your commit messages again. ;)
+4. Enjoy.
+
+There's also a shortcut for removing the commit_hookr files:
+
+    hookr clear
+    
+== Issues
+
+Committing with GitX won't work after initializing the Codebase hook. It's still a useful tool though, you just won't be able to hit the commit button.
+
+If you come across any, either fix the problem and send me a pull request, or post it to http://github.com/skddc/commit_hookr/issues .
 
 == Note on Patches/Pull Requests
  

data/features/cli.feature

@@ -4,8 +4,8 @@ Feature: commit_hookr Command Line Interface
   I want to use the hookr command to add and remove commit hooks
 
   Background:
-    Given a directory named "~/some_project"
-    And I cd to "~/some_project"
+    Given a directory named "some_project"
+    And I cd to "some_project"
     And I run "git init"
 
   Scenario: Run hookr in a directory that's not a Git project root
@@ -36,7 +36,7 @@ Feature: commit_hookr Command Line Interface
       | .git/hooks/commit-msg |
     
   Scenario: Clear commit hook
-    When I run hookr with "init codebase"
+    Given I run hookr with "init codebase"
     When I run hookr with "clear"
     Then I should see "Well then, if it makes you happy..."
     

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Michael Bumann
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-20 00:00:00 +01:00
+date: 2010-03-21 00:00:00 +01:00
 default_executable: hookr
 dependencies: 
 - !ruby/object:Gem::Dependency