Skip to content

Commit

Permalink
Better visibility to contributing docs.
Browse files Browse the repository at this point in the history
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 <me@jessfraz.com>
  • Loading branch information
jessfraz committed Jul 12, 2016
1 parent 5f2460b commit 83403b9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit 83403b9

Please sign in to comment.