Skip to content

Commit

Permalink
move the contributing hook into hack, and use curl in the same way as…
Browse files Browse the repository at this point in the history
… the gofmt above

and remove the fmt-check one we don't document

tianon tells me they're called GitHub, not Github :)

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
  • Loading branch information
SvenDowideit committed Jan 22, 2014
1 parent 3cb5bc5 commit 7c55cbd
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 60 deletions.
18 changes: 6 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ feels wrong or incomplete.
## Reporting Issues

When reporting [issues](https://github.com/dotcloud/docker/issues)
on Github please include your host OS ( Ubuntu 12.04, Fedora 19, etc... )
on GitHub please include your host OS ( Ubuntu 12.04, Fedora 19, etc... )
and the output of `docker version` along with the output of `docker info` if possible.
This information will help us review and fix your issue faster.

Expand Down Expand Up @@ -45,7 +45,7 @@ else is working on the same thing.

### Create issues...

Any significant improvement should be documented as [a github
Any significant improvement should be documented as [a GitHub
issue](https://github.com/dotcloud/docker/issues) before anybody
starts working on it.

Expand Down Expand Up @@ -146,19 +146,13 @@ then you just add a line to every git commit message:
using your real name (sorry, no pseudonyms or anonymous contributions.)

One way to automate this, is customise your get ``commit.template`` by adding
the following to your ``.git/hooks/prepare-commit-msg`` script (needs
``chmod 755 .git/hooks/prepare-commit-msg`` ) in the docker checkout:
a ``prepare-commit-msg`` hook to your docker checkout:

```
#!/bin/sh
# Auto sign all commits to allow them to be used by the Docker project.
# see https://github.com/dotcloud/docker/blob/master/CONTRIBUTING.md#sign-your-work
#
GH_USER=$(git config --get github.user)
SOB=$(git var GIT_AUTHOR_IDENT | sed -n "s/^\(.*>\).*$/Docker-DCO-1.1-Signed-off-by: \1 \(github: $GH_USER\)/p")
grep -qs "^$SOB" "$1" || echo "\n$SOB" >> "$1"
curl -o .git/hooks/prepare-commit-msg https://raw.github.com/dotcloud/docker/master/contrib/prepare-commit-msg.hook && chmod +x .git/hooks/prepare-commit-msg
``
```
* Note: the above script expects to find your GitHub user name in ``git config --get github.user``
If you have any questions, please refer to the FAQ in the [docs](http://docs.docker.io)
Expand Down
7 changes: 7 additions & 0 deletions contrib/prepare-commit-msg.hook
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/sh
# Auto sign all commits to allow them to be used by the Docker project.
# see https://github.com/dotcloud/docker/blob/master/CONTRIBUTING.md#sign-your-work
#
GH_USER=$(git config --get github.user)
SOB=$(git var GIT_AUTHOR_IDENT | sed -n "s/^\(.*>\).*$/Docker-DCO-1.1-Signed-off-by: \1 \(github: $GH_USER\)/p")
grep -qs "^$SOB" "$1" || echo "\n$SOB" >> "$1"
2 changes: 1 addition & 1 deletion docs/sources/articles/baseimages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ It can be as simple as this to create an Ubuntu base image::
DISTRIB_DESCRIPTION="Ubuntu 13.04"

There are more example scripts for creating base images in the
Docker Github Repo:
Docker GitHub Repo:

* `BusyBox <https://github.com/dotcloud/docker/blob/master/contrib/mkimage-busybox.sh>`_
* `CentOS / Scientific Linux CERN (SLC)
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ Where can I find more answers?
* `Docker user mailinglist`_
* `Docker developer mailinglist`_
* `IRC, docker on freenode`_
* `Github`_
* `GitHub`_
* `Ask questions on Stackoverflow`_
* `Join the conversation on Twitter`_

Expand Down
46 changes: 0 additions & 46 deletions hack/fmt-check.hook

This file was deleted.

0 comments on commit 7c55cbd

Please sign in to comment.