From a3f1880405bc64d1b717b4189b5ce26fdafb2a59 Mon Sep 17 00:00:00 2001 From: Jared Date: Tue, 8 Nov 2016 14:49:02 -0800 Subject: [PATCH] creating contributing.md Adding a contributing.md file with contributing guidelines for docs on kubernetes.io (https://github.com/blog/1184-contributing-guidelines). This should not be merged until the PR for the docs style guide is merged. (https://github.com/kubernetes/kubernetes.github.io/pull/1619) --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000..9dd8149a1513f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to Kubernetes Documentation + +**First off, thanks for taking the time to contribute!** + +The following is a set of guidelines for contributing to Kubernetes documentation, hosted at [Kubernetes.io](http://kubernetes.io/). +These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + +## Before you get started + +### Code of Conduct + +Kubernetes follows the [Cloud Native Computing Foundation (CNCF) Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to Sarah Novotny [sarahnovotny@google.com](mailto:sarahnovotny@google.com) and/or Dan Kohn [dan@linuxfoundation.org](mailto:dan@linuxfoundation.org). + +### Documentation and Site Decisions + +The [Kubernetes SIG Docs Discussion Group](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) is the discussion group for doc releases, suggested site improvements, and improving the doc contribution experience. If you are planning to be a regular contributor, join this group to stay informed and involved. + +### Style Guides and Templates + +Before submitting a pull request to create new content, please review the [Kubernetes.io style guide](http://kubernetes.io/docs/contribute/style-guide/) and follow the [instructions for using page templates](http://kubernetes.io/docs/contribute/page-templates/). + + +## Contributing to Documentation + +### Reporting Documentation Issues + +Kubernetes.io uses github issues to track documentation issues and requests. If you see a documentation issue, submit an issue using the following steps: + +1. Check the [kubernetes.io issues list](https://github.com/kubernetes/kubernetes.github.io/issues) as you might find out the issue is a duplicate. +2. Use the [included template for every new issue](https://github.com/kubernetes/kubernetes.github.io/issues/new). When you create a bug report, include as many details as possible and include suggested fixes to the issue. + +Note that code issues should be filed against the main kubernetes repository, while documentation issues should go in the kubernetes.io repository. + +### Submitting Documentation Pull Requests + +If you’re fixing an issue in the existing documentation, you should submit a PR against the master branch. Follow [these instructions to create a documentation pull request against the kubernetes.io repository](http://kubernetes.io/docs/contribute/create-pull-request/).