Skip to content

Commit 5c24a81

Browse files
committed
minor doc. update
1 parent b659419 commit 5c24a81

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Git Commit Notifier
22

3-
[![Build Status](http://travis-ci.org/bitboxer/git-commit-notifier.png)](http://travis-ci.org/bitboxer/git-commit-notifier)
3+
[![Build Status](https://travis-ci.org/bitboxer/git-commit-notifier.png)](http://travis-ci.org/bitboxer/git-commit-notifier)
44

55
__by Bodo Tasche (bodo 'at' wannawork 'dot' de), Akzhan Abdulin (akzhan 'dot' abdulin 'at' gmail 'dot' com), Csoma Zoltan (info 'at' railsprogrammer 'dot' net)__
66

@@ -9,7 +9,7 @@ Email is delivered as text or HTML with changes refined per word. Emails
99
have a scannable subject containing the first sentence of the commit as well
1010
as the author, project and branch name.
1111

12-
It''s also possible to send a mail to a newsgroup using NNTP.
12+
It's also possible to send a mail to a newsgroup using NNTP.
1313

1414
For example:
1515

@@ -37,22 +37,28 @@ We do not support ruby 1.8.6 because of nokogiri gem.
3737

3838
Install the gem:
3939

40-
sudo gem install git-commit-notifier
40+
```bash
41+
sudo gem install git-commit-notifier
42+
```
4143

4244
After you installed the gem, you need to configure your git repository. Add a file called
4345
"post-receive" to the "hooks" directory of your git repository with this content:
4446

45-
#!/bin/sh
46-
git-commit-notifier path_to_config.yml
47+
```bash
48+
#!/bin/sh
49+
git-commit-notifier path_to_config.yml
50+
```
4751

48-
(Don''t forget to make that file executable.)
52+
(Don't forget to make that file executable.)
4953

5054
An example for the config file can be found in [config/git-notifier-config.yml.sample](http://github.com/bitboxer/git-commit-notifier/blob/master/config/git-notifier-config.yml.sample).
5155

5256
If you want to send mails on each commit instead on each push, you should add a file called "post-commit" with this content:
5357

58+
```bash
5459
#!/bin/sh
5560
echo "HEAD^1 HEAD refs/heads/master" | git-commit-notifier path_to_config.yml
61+
```
5662

5763
## Integration with Redmine, Bugzilla, MediaWiki
5864

@@ -87,8 +93,8 @@ handled commits to not send repeated messages about commits.
8793
By default all commits are tracked through the whole repository so after a merge
8894
you should not receive messages about those commits already posted in other branches.
8995
90-
This behaviour can be changed using unique\_commits\_per\_branch option. When it''s true,
91-
you should receive new message about commit when it''s merged in other branch.
96+
This behaviour can be changed using unique\_commits\_per\_branch option. When it's true,
97+
you should receive new message about commit when it's merged in other branch.
9298
9399
Yet another option, skip\_commits\_older\_than (in days), should be used to not inform about
94100
old commits in processes of forking, branching etc.
@@ -97,7 +103,7 @@ old commits in processes of forking, branching etc.
97103
98104
* Fork the project.
99105
* Make your feature addition or bug fix.
100-
* Add tests for it. This is important so I don''t break it in a
106+
* Add tests for it. This is important so I don't break it in a
101107
future version unintentionally.
102108
* Commit, do not mess with rakefile, version, or history.
103109
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

0 commit comments

Comments
 (0)