From 83403b9d7d3a6353f51f6699513678037f797f35 Mon Sep 17 00:00:00 2001 From: Jess Frazelle Date: Thu, 7 Jul 2016 14:55:33 -0700 Subject: [PATCH] Better visibility to contributing docs. 1. Updates the README.md to have a heading with the word "contribute", long time OSS contributors (or maybe I just do this) skim docs quickly and need a large call out to exactly what they are looking for. 2. The best resource I found was a developer guide that wasn't even linked in CONTRIBUTING.md, which seems like a shame so I made it right at the top! Signed-off-by: Jess Frazelle --- CONTRIBUTING.md | 6 ++++++ README.md | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9447c5a15c8..65c7bfe67b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,11 @@ # Contributing guidelines +Want to hack on kubernetes? Yay! + +## Developer Guide + +We have a [Developer's Guide](docs/devel/README.md) that outlines everything you need to know from setting up your dev environment to how to get faster Pull Request reviews. And of course if you find something undocumented or incorrect along the way, feel free to send a PR! + ## Filing issues If you have a question about Kubernetes or have a problem using Kubernetes, before filing an issue, please read the [troubleshooting guide](docs/troubleshooting.md). diff --git a/README.md b/README.md index 1c395db1ec1..ba55de45ec3 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ For Q&A, our threads are at: * [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes) * [Slack](http://slack.k8s.io/) -### Want to do more than just 'discuss' Kubernetes? +### Want to contribute to Kubernetes? If you're interested in being a contributor and want to get involved in developing Kubernetes, start in the [Kubernetes Developer Guide](docs/devel/README.md) and also review the [contributor guidelines](CONTRIBUTING.md).