diff options
| author | nidorano <fjmoralesmartinez@hotmail.com> | 2018-03-05 12:54:56 +0100 |
|---|---|---|
| committer | nidorano <fjmoralesmartinez@hotmail.com> | 2018-03-05 12:54:56 +0100 |
| commit | 32d5b2283c47d54a71a29bb19b45157814b45f36 (patch) | |
| tree | a9a05e7839ad61dbfd2186b03a7aa46a75d6bbaa /sig-cli/CONTRIBUTING.md | |
| parent | bad95e7723049158128c96620993de83cab42321 (diff) | |
sig-cli contributing.md update and fixes
Diffstat (limited to 'sig-cli/CONTRIBUTING.md')
| -rw-r--r-- | sig-cli/CONTRIBUTING.md | 38 |
1 files changed, 16 insertions, 22 deletions
diff --git a/sig-cli/CONTRIBUTING.md b/sig-cli/CONTRIBUTING.md index 10dc3421..8eed1db1 100644 --- a/sig-cli/CONTRIBUTING.md +++ b/sig-cli/CONTRIBUTING.md @@ -1,22 +1,29 @@ # Contributing -The process for contributing code to Kubernetes via SIG-cli [community][community page]. +Welcome to the Kubernetes sig-cli contributing guide. We are excited +about the prospect of you joining our [community][community page]! -**Note**: This page is focused on helping new contributors become active -members of the community through sustained contributions. +## Before You Begin -## Introduction +We strongly recommend you to understand the main [Kubernetes Contributor Guide](http://git.k8s.io/community/contributors/guide) and adhere to the contribution rules. -Welcome to the Kubernetes sig-cli contributing guide. We are excited -about the prospect of you joining our [community][community page]! -Mentoring and on-boarding new contributors is critical to the success -of the project. +You can also check the [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet.md), with common resources for existing developers. + +The process for contributing code to Kubernetes via SIG-cli [community][community page]. Please be aware that all contributions to Kubernetes require time + and commitment from project maintainers to direct and review work. This is done in additional to many other maintainer responsibilities, and direct engagement from maintainers is a finite resource. +### Learn a bit about the kubectl cli + +This is important. + +- Learn about using kubectl with Kubernetes in the [Kubernetes Basics Tutorial]. +- Learn about managing configuration in the [kubectl docs]. + ## Pick your track Determine in what capacity you are looking to contribute: @@ -66,20 +73,7 @@ Since maintainers will need to own any code for these contributions, these shoul be very limited in scope and contain minimal risk (e.g. simple regression fixes, improved documentation, improved testing). -## Before You Begin - -**Note**: Complete the following steps before reaching out to cli community members. - -### Agree to contribution rules - -Follow the [CLA signup instructions](../CLA.md). - -### Learn a bit about the kubectl cli - -This is important. - -- Learn about using kubectl with Kubernetes in the [Kubernetes Basics Tutorial]. -- Learn about managing configuration in the [kubectl docs]. +- ### Modify your own `kubectl` fork |