README.md

Documentation: k8s.io/kubectl

     1# Kubectl
     2
     3![kubectl logo](./images/kubectl-logo-medium.png)
     4
     5[![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)
     6
     7The `k8s.io/kubectl` repo is used to track issues for the kubectl cli distributed
     8with `k8s.io/kubernetes`. It also contains packages intended for use by client
     9programs. E.g. these packages are vendored into `k8s.io/kubernetes` for use in
    10the [kubectl](https://github.com/kubernetes/kubernetes/tree/master/cmd/kubectl)
    11cli client. That client will eventually move here too.
    12
    13## Contribution Requirements
    14
    15- Full unit-test coverage.
    16
    17- Go tools compliant (`go get`, `go test`, etc.). It needs to be vendorable
    18  somewhere else.
    19
    20- No dependence on `k8s.io/kubernetes`. Dependence on other repositories is fine.
    21
    22- Code must be usefully [commented](https://go.dev/doc/effective_go#commentary).
    23  Not only for developers on the project, but also for external users of these packages.
    24
    25- When reviewing PRs, you are encouraged to use Golang's [code review
    26  comments](https://github.com/golang/go/wiki/CodeReviewComments) page.
    27
    28- Packages in this repository should aspire to implement sensible, small
    29  interfaces and import a limited set of dependencies.
    30
    31## Community, discussion, contribution, and support
    32
    33See [this document](https://github.com/kubernetes/community/tree/master/sig-cli) for how to reach the maintainers of this project.
    34
    35### Code of conduct
    36
    37Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
    38
View as plain text