Skip to content

Latest commit

 

History

History
145 lines (107 loc) · 6.54 KB

CONTRIBUTING.md

File metadata and controls

145 lines (107 loc) · 6.54 KB
Raw

Contributing guidelines

Want to hack on Kubernetes? Yay!

Developer Guide

We have a Developer's Guide that outlines everything you need to know from setting up your dev environment to how to get faster Pull Request reviews. If you find something undocumented or incorrect along the way, please feel free to send a Pull Request.

Filing issues

If you have a question about Kubernetes or have a problem using it, please start with the troubleshooting guide. If that doesn't answer your questions, or if you think you found a bug, please file an issue.

How to become a contributor and submit your own code

Contributor License Agreements

We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.

Please fill out either the individual or corporate Contributor License Agreement (CLA). As of Q4 2016, we're transitioning from Google's CLA to the Cloud Native Computing Foundation (CNCF) CLA.

Google:

  • If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

CNCF:

  • To contribute as an individual or as am employee of a signed organization, go here.
  • To sign up as an organization, go here.

Once you are CLA'ed, we'll be able to accept your pull requests.

NOTE: Only original source code from you and other people that have signed the CLA can be accepted into the repository. This policy does not apply to third_party and vendor.

Finding Things That Need Help

If you're new to the project and want to help, but don't know where to start, we have a semi-curated list of issues that have should not need deep knowledge of the system. Have a look and see if anything sounds interesting.

Alternatively, read some of the many docs on the system, for example the architecture, and pick a component that seems interesting. Start with main() (look in the cmd directory) and read until you find something you want to fix. The best way to learn is to hack! There's always code that can be clarified and variables or functions that can be renamed or commented.

Contributing A Patch

If you're working on an existing issue, such as one of the help-wanted ones above, simply respond to the issue and express interest in working on it. This helps other people know that the issue is active, and hopefully prevents duplicated efforts.

If you want to work on a new idea of relatively small scope:

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owners will respond to your issue promptly.
  3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
  4. Fork the repo, develop, and test your changes.
  5. Submit a pull request.

If you want to work on a bigger idea, we STRONGLY recommend that you start with some bugs or smaller features. We have a feature development process, but navigating the Kubernetes system as a newcomer can be very challenging.

Downloading the project

There are a few ways you can download this code. You must download it into a GOPATH - see golang.org for more info on how Go works with code. This project expects to be found at the Go package k8s.io/kubernetes.

  1. You can git clone the repo. If you do this, you MUST make sure it is in the GOPATH as k8s.io/kubernetes or it may not build. E.g.: git clone https://github.com/kubernetes/kubernetes $GOPATH/src/k8s.io/kubernetes
  2. You can use go get to fetch the repo. This will automatically put it into your GOPATH in the right place. E.g.: go get -d k8s.io/kubernetes
  3. You can download an archive of the source. If you do this, you MUST make sure it is unpacked into the GOPATH as k8s.io/kubernetes or it may not build. See rel.k8s.io for a list of available releases.

Building the project

There are a few things you need to build and test this project:

  1. make - the human interface to the Kubernetes build is make, so you must have this tool installed on your machine. We try not to use too many crazy features of Makefiles and other tools, so most commonly available versions should work.
  2. docker - some parts of the build/test system depend on docker. You need a relatively recent version of Docker installed, and available to you.
  3. go - Kubernetes is written in Go (aka golang), so you need a relatively recent version of the Go toolchain installed. While Linux is the primary platform for Kubernetes, it should compile on a Mac, too. Windows is in progress.

To build Kubernetes, simply type make. This should figure out what it needs to do and not need any input from you. If you want to just build a subset of code, you can pass the WHAT variable to make: e.g. make WHAT="cmd/kubelet".

To run basic tests, simply type make test. This will run all of the unit tests in the project. If you want to just test a subset of the project, you can pass the WHAT variable to make: e.g. make test WHAT=pkg/kubelet.

Protocols for Collaborative Development

Please read this doc for information on how we're running development for the project. Also take a look at the development guide for information on how to set up your environment, run tests, manage dependencies, etc.

Adding dependencies

If your patch depends on new packages, add that package with godep. Follow the instructions to add a dependency.

Community Expectations

Please see our expectations for members of the Kubernetes community.

Analytics