LBRYCommunity/tracker
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

docs: move contributing info into CONTRIBUTING.MD

Browse source
This commit is contained in:
Jimmy Zelinskie 2015-01-28 23:06:22 -05:00
parent 88df5e2c74
commit dd2c1e95fc
2 changed files with 39 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,39 @@
## Code conventions
The project follows idiomatic [Go conventions] for style.
[Go conventions]: https://github.com/jzelinskie/conventions
## Communication
Currently, real time conversation happens on [#chihaya] on [freenode].
We are currently attempting to have more information available on GitHub.
[#chihaya]: http://webchat.freenode.net?channels=chihaya
[freenode]: http://freenode.net
## Pull request procedure
Please don't write massive patches without prior communication, as it will most
likely lead to confusion and time wasted for everyone. However, small
unannounced fixes are always welcome!
Pull requests should be targeted at the `master` branch. Before pushing to your
Github repo and issuing the pull request, please do two things:
1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your
local changes against the `master` branch. Resolve any conflicts
that arise.
2. Run the test suite with the `godep go test -v ./...` command.
Pull requests will be treated as "review requests", and we will give
feedback we expect to see corrected on [style] and substance before pulling.
Changes contributed via pull request should focus on a single issue at a time,
like any other. We will not accept pull-requests that try to "sneak" unrelated
changes in.
Any new files should include the license header found at the top of every
source file.
[style]: https://github.com/jzelinskie/conventions

8
README.md
View file

@ -49,11 +49,3 @@ There is also a set of benchmarks for performance-critical sections of Chihaya.
$ cd $GOPATH/src/github.com/chihaya/chihaya $ cd $GOPATH/src/github.com/chihaya/chihaya
$ godep go test -v ./... -bench . $ godep go test -v ./... -bench .
``` ```
## Contributing
The project follows idiomatic [Go conventions] for style. If you're interested in contributing, please contact us via IRC in **[#chihaya] on [freenode]** or post to the GitHub issue tracker. Please don't write massive patches with no prior communication, as it will most likely lead to confusion and time wasted for everyone. However, small unannounced fixes are always welcome!
[#chihaya]: http://webchat.freenode.net?channels=chihaya
[freenode]: http://freenode.net
[Go conventions]: https://github.com/jzelinskie/conventions