Skip to content

Commit 6c8f679

Browse files
author
Bob Vincent
committed
Clean up README.md:
* Update maintainers section and move to bottom. * Word-wrap at 80 chars. * Minor punctuation tweaks.
1 parent 265672d commit 6c8f679

File tree

1 file changed

+30
-11
lines changed

1 file changed

+30
-11
lines changed

README.md

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
Looking for additional maintners. I do not use puppet on a daily basis anymore, so I'd appreciate an extra
2-
help ensuring this project meets the needs of the people using it. Please contact me through github if you
3-
are interested in helping maintain this project. Thank you!
4-
51
puppet-git-hooks
62
================
73

8-
Git hooks to assist puppet module development. Client side hooks allow for various checks before commits are staged. Server side hooks are provided for infrastructural reinforcement of various standardization compliances.
4+
Git hooks to assist puppet module development. Client side hooks allow for
5+
various checks before commits are staged. Server side hooks are provided
6+
for infrastructural reinforcement of various standardization compliances.
97

108
Current supported pre-commit (client side) checks
119
=================================================
@@ -31,7 +29,10 @@ Current supported pre-receive (server side) checks
3129
Installing dependencies
3230
=======================
3331

34-
You can install all required dependencies with bundler. List of dependencies you will find in `Gemfile`. By default it installs puppet in version 3.8.6, if you wish, change it to one, which you use. To install run bundler inside your checkout:
32+
You can install all required dependencies with bundler. List of dependencies
33+
you will find in `Gemfile`. By default it installs puppet in version 3.8.6,
34+
if you wish, change it to one, which you use. To install run bundler inside
35+
your checkout:
3536

3637
```bash
3738
bundle install
@@ -40,13 +41,16 @@ bundle install
4041
Usage
4142
=====
4243

43-
In your git repository you can symlink the pre-commit file from this repository to the .git/hooks/pre-commit of your repository you want to implement this feature.
44+
In your git repository you can symlink the pre-commit file from this
45+
repository to the .git/hooks/pre-commit of your repository you want to
46+
implement this feature.
4447

4548
```bash
4649
$ ln -s /path/to/this/repo/puppet-git-hooks/pre-commit .git/hooks/pre-commit
4750
```
4851

49-
If you are using git submodules this can be achieved by getting the gitdir from the .git file in your submodule and symlinking to that gitdir location/
52+
If you are using git submodules this can be achieved by getting the gitdir
53+
from the .git file in your submodule and symlinking to that gitdir location/
5054

5155
```bash
5256
$ cat .git
@@ -84,12 +88,13 @@ deploy-git-hook
8488

8589
In a wrapper
8690
===============
87-
You can call from your own custom pre-commit. This allows you to combine these with your own checks
91+
You can call from your own custom pre-commit. This allows you to combine
92+
these with your own checks.
8893

8994
For example, if you've cloned this repo to ~/.puppet-git-hooks
9095

9196

92-
The .git/hooks/pre-commit with your puppet code might look like this
97+
The .git/hooks/pre-commit with your puppet code might look like this:
9398

9499
```bash
95100
#!/bin/bash
@@ -102,7 +107,10 @@ if [ -e ~/.puppet-git-hooks/pre-commit ]; then
102107
fi
103108
```
104109

105-
Additionally you can call pre-commit script with two options `-s` and `-a`. First one silence standard informations, which file is currently being checked. Second one allow you to check whole repo, not only files changed locally.
110+
Additionally you can call pre-commit script with two options `-s` and `-a`.
111+
First one silence standard informations, which file is currently being
112+
checked. Second one allow you to check whole repo, not only files changed
113+
locally.
106114

107115
Configuration
108116
===============
@@ -117,3 +125,14 @@ Current options:
117125
* PUPPET_LINT_OPTIONS
118126
* PUPPET_LINT_FAIL_ON_WARNINGS
119127
* UNSET_RUBY_ENV (for GitLab users)
128+
129+
Maintainers
130+
===========
131+
132+
* [David Wahlstrom](https://github.com/drwahl)
133+
* [Paweł Szczepaniak](https://github.com/krzyzakp)
134+
135+
We are still looking for additional maintainers. Please contact me via
136+
[github issue](https://github.com/drwahl/puppet-git-hooks/issues/new)
137+
if you are interested in helping maintain this project. Thank you!
138+

0 commit comments

Comments
 (0)