dm/vain
1
0
Fork 0
forked from sm/vain
Code

updated contributing.md for hosting on github

Browse Source
This commit is contained in:
Derek McQuay 2016-09-09 12:58:19 -07:00
parent 559cbd0132
commit ef1ee3d840
1 changed files with 8 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
contributing.md
View File

@ -5,27 +5,20 @@ agree to abide by the golang [code of conduct].
[code of conduct]: https://golang.org/conduct [code of conduct]: https://golang.org/conduct
I'm trying an experiment in running as much of my own infrastructure as
I possibly can, which includes hosting my git repos using [gogs] at
https://s.mcquay.me/. As such contributing will be slightly more complex than
a simple pull request on github. Sorry for the inconvenience.
[gogs]: https://gogs.io
The basic steps begin with a clone this repo: The basic steps begin with a clone this repo:
$ git clone https://s.mcquay.me/sm/vain.git $GOPATH/src/mcquay.me/vain $ git clone https://github.com/dmmcquay/vain.git $GOPATH/src/github.com/dmmcquay/vain
then set up to push up to your hosting service of choice, e.g.: then set up to push up to your hosting service of choice, e.g.:
$ cd $GOPATH/src/mcquay.me/vain $ cd $GOPATH/src/github.com/dmmcquay/vain
$ git remote add mine git@github.com/you/vain.git $ git remote add mine git@github.com/you/vain.git
add a feature and some tests then run the tests, check your formatting: add a feature and some tests then run the tests, check your formatting:
$ go test mcquay.me/vain $ go test github.com/dmmcquay/vain
$ go vet mcquay.me/vain $ go vet github.com/dmmcquay/vain
$ golint mcquay.me/vain $ golint github.com/dmmcquay/vain
If things look good and tests pass commit and push to your remote: If things look good and tests pass commit and push to your remote:
@ -34,14 +27,9 @@ If things look good and tests pass commit and push to your remote:
$ git push mine feature $ git push mine feature
Push to your fork and email a pull request to stephen at mcquay dot me with Push to your fork and at this point you're waiting on us. We will comment on
a link to your branch, of the form: the pull request request within three business days (and, typically, one
business day). We may suggest some changes or improvements or alternatives.
https://github.com/you/vain/tree/branch-name
At this point you're waiting on us. We will comment on the pull request request
within three business days (and, typically, one business day). We may suggest
some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted: Some things that will increase the chance that your pull request is accepted: