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

Add contributor guide

pull/4964/head
Thomas Stromberg 2019-08-02 18:04:45 -07:00
parent 5e4696fd00
commit 1fcd6fce56
1 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
site/content/en/docs/Contributing/guide.en.md Normal file
View File

@ -0,0 +1,42 @@
---
title: "Contributor Guide"
date: 2019-07-31
weight: 1
description: >
How to become a minikube contributor
---
### Code of Conduct
Be excellent to each another. Please refer to our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md).
### License Agreement
We'd love to accept your patches! Before we can take them, [please fill out either the individual or corporate Contributor License Agreement (CLA)](http://git.k8s.io/community/CLA.md)
### Finding issues to work on
* ["good first issue"](https://github.com/kubernetes/minikube/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues where there is a clear path to resolution
* ["help wanted"](https://github.com/kubernetes/minikube/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+) - any issue where we've identified a need, but not the resources to work on it.
* High impact issues are labelled as *priority/important-soon* or *priority/important-longterm*
* Ask on the #minikube Slack if you aren't sure
Once you've discovered an issue to work on:
* add a comment mentioning that you plan to work on the issue
* send a PR out that mentions the issue
* Once there is a PR, comment on the issue with `/assign` to assign it to yourself
### Contributing A Patch
1. Submit an issue describing your proposed change
2. A reviewer will respond to your issue promptly.
3. If your proposed change is accepted, and you haven't already done so, sign the [Contributor License Agreement (CLA)](http://git.k8s.io/community/CLA.md)
4. Fork the minikube repository, develop and test your code changes.
5. Submit a pull request.
### Style Guides
For coding, refer to the [Kubernetes Coding Conventions](https://github.com/kubernetes/community/blob/master/contributors/guide/coding-conventions.md#code-conventions)
For documentation, refer to the [Kubernetes Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/)