diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5128857 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# Contributing + +First, thank you for contributing! We love and encourge pull requests from everyone. + +Here are a few guidelines to follow: + +1. Open an [issue][issues] to discuss a new feature. +1. Write tests. +1. Make sure the entire test suite passes locally and on Travis CI. +1. Open a Pull Request. +1. [Squash your commits][squash] after receiving feedback and add a [great commit message][message]. +1. Have fun! + +[issues]: https://github.com/go-kit/kit/issues +[squash]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html +[message]: https://github.com/go-kit/kit/issues diff --git a/log/README.md b/log/README.md index 57d22c9..57ab485 100644 --- a/log/README.md +++ b/log/README.md @@ -52,3 +52,10 @@ stdlog.SetOutput(kitlog.NewStdlibAdapter(logger)) } ``` + +## Contributing + +Please see [CONTRIBUTING.md]. Thank you, [contributors]! + +[CONTRIBUTING.md]: /CONTRIBUTING.md +[contributors]: https://github.com/go-kit/kit/graphs/contributors