kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

sig-cli contributing.md update and fixes

This commit is contained in:
nidorano 2018-03-05 12:54:56 +01:00
parent bad95e7723
commit 32d5b2283c
1 changed files with 17 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
sig-cli/CONTRIBUTING.md
View File

@ -1,22 +1,29 @@
# Contributing # Contributing
The process for contributing code to Kubernetes via SIG-cli [community][community page].
**Note**: This page is focused on helping new contributors become active
members of the community through sustained contributions.
## Introduction
Welcome to the Kubernetes sig-cli contributing guide. We are excited Welcome to the Kubernetes sig-cli contributing guide. We are excited
about the prospect of you joining our [community][community page]! about the prospect of you joining our [community][community page]!
Mentoring and on-boarding new contributors is critical to the success
of the project. ## Before You Begin
We strongly recommend you to understand the main [Kubernetes Contributor Guide](http://git.k8s.io/community/contributors/guide) and adhere to the contribution rules.
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 Please be aware that all contributions to Kubernetes require time
and commitment from project maintainers to direct and review work. and commitment from project maintainers to direct and review work.
This is done in additional to many other maintainer responsibilities, and This is done in additional to many other maintainer responsibilities, and
direct engagement from maintainers is a finite resource. 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 ## Pick your track
Determine in what capacity you are looking to contribute: 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 be very limited in scope and contain minimal risk
(e.g. simple regression fixes, improved documentation, improved testing). (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 ### Modify your own `kubectl` fork