Codebase list golang-github-go-kit-kit / bf336c5
Merge pull request #51 from harlow/hw-contributing Add guidelines for contributing Peter Bourgon 8 years ago
2 changed file(s) with 26 addition(s) and 8 deletion(s). Raw diff Collapse all Expand all
+22
-0
CONTRIBUTING.md less more
0 # Contributing
1
2 First, thank you for contributing! We love and encourge pull requests from everyone.
3
4 At this stage, we're still developing the initial drafts of all of the packages, using an
5 [RFC workflow](https://github.com/go-kit/kit/tree/master/rfc).
6
7 Before submitting major changes, here are a few guidelines to follow:
8
9 1. Check the [open issues][issues] and [pull requests][prs] for existing discussions.
10 1. Open an [issue][issues] to discuss a new feature.
11 1. Write tests.
12 1. Make sure the entire test suite passes locally and on Travis CI.
13 1. Open a Pull Request.
14 1. [Squash your commits][squash] after receiving feedback and add a [great commit message][message].
15 1. Have fun!
16
17 [issues]: https://github.com/go-kit/kit/issues
18 [prs]: https://github.com/go-kit/kit/pulls
19 [squash]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
20 [message]: https://github.com/go-kit/kit/issues
21
+4
-8
README.md less more
3434
3535 ## Contributing
3636
37 At this stage, we're still developing the initial drafts of all of the packages, using an
38 [RFC workflow](https://github.com/go-kit/kit/tree/master/rfc).
39 Before submitting major changes, please write to
40 [the mailing list](https://groups.google.com/forum/#!forum/go-kit)
41 to register your interest, and check the
42 [open issues](https://github.com/go-kit/kit/issues) and
43 [pull requests](https://github.com/go-kit/kit/pulls)
44 for existing discussions.
37 Please see [CONTRIBUTING.md]. Thank you, [contributors]!
38
39 [CONTRIBUTING.md]: /CONTRIBUTING.md
40 [contributors]: https://github.com/go-kit/kit/graphs/contributors
4541
4642 ### Dependency management
4743