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

Clarify requirements in README.md

This commit is contained in:
Antoine Pelisse 2017-11-13 13:49:17 -08:00
parent bcbe5fae3f
commit b948167a49
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,6 +1,30 @@
# Kubectl # Kubectl
The k8s.io/kubectl repo is used to track issues for the kubectl cli distributed with k8s.io/kubernetes. [![Build Status](https://travis-ci.org/kubernetes/kubectl.svg?branch=master)](https://travis-ci.org/kubernetes/kubectl) [![GoDoc](https://godoc.org/k8s.io/kubectl?status.svg)](https://godoc.org/k8s.io/kubectl)
The `k8s.io/kubectl` repo is used to track issues for the kubectl cli distributed
with `k8s.io/kubernetes`. It also contains packages intended for use by client
programs. E.g. these packages are vendored into `k8s.io/kubernetes` for use in
the [kubectl](https://github.com/kubernetes/kubernetes/tree/master/cmd/kubectl)
cli client. That client will eventually move here too.
# Contribution Requirements
- Full unit-test coverage.
- Go tools compliant (`go get`, `go test`, etc.). It needs to be vendorable
somewhere else.
- No dependence on `k8s.io/kubernetes`. Dependence on other repositories is fine.
- Code must be usefully [commented](https://golang.org/doc/effective_go.html#commentary).
Not only for developers on the project, but also for external users of these packages.
- When reviewing PRs, you are encouraged to use Golang's [code review
comments](https://github.com/golang/go/wiki/CodeReviewComments) page.
- Packages in this repository should aspire to implement sensible, small
interfaces and import a limited set of dependencies.
## Community, discussion, contribution, and support ## Community, discussion, contribution, and support