Skip to content
Browse files

Fix grammer, typos, and confusing language

  • Loading branch information...
1 parent 4bbc928 commit 773395a5e2c25f5c303bc791e537b020671f2122 @stevenharman stevenharman committed Jul 26, 2012
Showing with 9 additions and 9 deletions.
  1. +9 −9 README.md
View
18 README.md
@@ -32,24 +32,24 @@ $ git-tracker install
This will put the `prepare-commit-msg` hook in the `/path/to/repo/.git/hooks`
directory and make it executable.
-**NOTE:** This will need to be done for each repository that you wish to use
-the hook.
+**NOTE:** The hook needs to be installed just once for each repository in which
+you will use it.
## Usage
With the hook installed in a repository, create branches being sure to include
the Pivotal Tracker story number in the branch name.
```bash
-$ git checkout -b a_useful_and_helpful_name_#8675309
+$ git checkout -b a_useful_and_helpful_name_8675309
```
When you commit, Git will fire the hook which will find the story number in the
branch name and prepare your commit message so that it include the story number
in the special Pivotal Tracker syntax.
```bash
-# on branch named `best_feature_ever-#8675309`
+# on branch named `best_feature_ever-8675309`
$ git commit
```
@@ -62,7 +62,7 @@ the top)*
[#8675309]
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
-# On branch best_feature_ever-#8675309
+# On branch best_feature_ever-8675309
# Changes to be committed:
# (use "git reset HEAD <file>..." to unstage)
#
@@ -79,7 +79,7 @@ If you pass a commit message on the command line the hook will still add the
story number, preceded by an empty line, to the end of your message.
```bash
-# on branch named `best_feature_ever-#8675309`
+# on branch named `best_feature_ever-8675309`
$ git commit -m'Look at this rad code, yo!'
```
@@ -95,15 +95,15 @@ However, if you include the story number in the Pivotal Tracker format in your
commit message, the hook will do nothing.
```bash
-# on branch named `best_feature_ever-#8675309`
+# on branch named `best_feature_ever-8675309`
$ git commit -m'[#8675309] Look at this rad code, yo!'
```
Results in this commit message:
```
-[#12356] Look at this rad code, yo!
+[#8675309] Look at this rad code, yo!
```
### Keywords
@@ -119,7 +119,7 @@ to the story ID in the commit message.
For example:
```bash
-# on branch named `bug/redis_connection_not_initializing_#8675309`
+# on branch named `bug/redis_connection_not_initializing_8675309`
$ git commit -am "Change the redis connection string [Fixes]"
```

0 comments on commit 773395a

Please sign in to comment.
Something went wrong with that request. Please try again.