Skip to content

Commit b73fa3b

Browse files
committed
Cleanup README examples
1 parent f2004e2 commit b73fa3b

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ With the hook initialized in a repository, create branches being sure to include
5151
the Pivotal Tracker story number in the branch name.
5252

5353
```bash
54-
$ git checkout -b a_useful_and_helpful_name_8675309
54+
$ git switch -c best_feature_ever_8675309
5555
```
5656

5757
When you commit, Git will fire the hook which will find the story number in the
5858
branch name and prepare your commit message so that it includes the story number
5959
in the [special Pivotal Tracker syntax][pt-format].
6060

6161
```bash
62-
# on branch named `best_feature_ever-8675309`
62+
# on branch named `best_feature_ever_8675309`
6363
$ git commit
6464
```
6565

@@ -72,7 +72,7 @@ the top)*
7272
[#8675309]
7373
# Please enter the commit message for your changes. Lines starting
7474
# with '#' will be ignored, and an empty message aborts the commit.
75-
# On branch best_feature_ever-8675309
75+
# On branch best_feature_ever_8675309
7676
# Changes to be committed:
7777
# (use "git reset HEAD <file>..." to unstage)
7878
#
@@ -89,7 +89,7 @@ If you pass a commit message on the command line the hook will still add the
8989
story number, preceded by an empty line, to the end of your message.
9090

9191
```bash
92-
# on branch named `best_feature_ever-8675309`
92+
# on branch named `best_feature_ever_8675309`
9393
$ git commit -m'Look at this rad code, yo!'
9494
```
9595

@@ -105,7 +105,7 @@ However, if you include the story number in the Pivotal Tracker format within
105105
your commit message, the hook will do nothing.
106106

107107
```bash
108-
# on branch named `best_feature_ever-8675309`
108+
# on branch named `best_feature_ever_8675309`
109109
$ git commit -m'[#8675309] Look at this rad code, yo!'
110110
```
111111

@@ -156,12 +156,11 @@ name, optionally prefixing it with a hash (`#`). Examples:
156156
## Contributing :octocat:
157157

158158
1. Fork it
159-
2. Create your feature branch (`git checkout -b my_new_feature`)
159+
2. Create your feature branch (`git switch -c my_new_feature`)
160160
3. Commit your changes (`git commit -am 'Added some feature'`)
161161
4. Push to the branch (`git push origin my_new_feature`)
162162
5. Create new Pull Request
163163

164-
165164
[pt]: https://www.pivotaltracker.com/
166165
[pt-format]: https://www.pivotaltracker.com/help/api?version=v3#scm_post_commit_message_syntax
167166
[tpope]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

0 commit comments

Comments
 (0)