Add Contribution 101 #1031

micw523 · 2019-12-13T20:29:01Z

Fixes #266
Fixes #1026
Fixes #910

Adds contribution 101.
Progress:

Package composition
Address Windows developers
Commits and squash commits
How to locally run tests

micw523 · 2019-12-13T20:53:46Z

/assign @yliaog
/assign @roycaihw
I finally got the time to work on this.

roycaihw

This looks pretty good. I left some comments.

CONTRIBUTING.md

scottilee · 2019-12-22T20:05:04Z

CONTRIBUTING.md

@@ -13,14 +13,77 @@ Please fill out either the individual or corporate Contributor License Agreement

 Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.

+## Composition of This Repository and Where/How to Contribute
+
+The repository of the Kubernetes Python client consists of this main repository and a submodule, the [python-base](https://github.com/kubernetes-client/python-base) repository. The main repository contains mostly files that are generated by the OpenAPI generator from [this OpenAPI spec](scripts/swagger.json). The base repo is the utility part of the python client and allows developers to create their own kubernetes clients.


"The repository of the Kubernetes Python client consists of this main repository" might be better as "The Kubernetes Python client consists of this main repository, the python"

Also in the last sentence, by "base repo" I think you mean python-base which you refer to above as "submodule". It might be clearer to someone new if you keep the terms consistent.

scottilee · 2019-12-22T20:08:31Z

CONTRIBUTING.md

+
+### Where to Submit Your Patch
+
+These folders are automatically generated. You will need to submit a patch to the upstream kubernetes repo [kubernetes](https://github.com/kubernetes/kubernetes) or the OpenAPI generator repo [openapi-generator](https://github.com/OpenAPITools/openapi-generator). This contains:


Could you clarify "These folders" -- I think "The following folders are automatically generated" would work, and then you can remove the "This contains:" part.

Minor nitpick, but "kubernetes repo" should be uppercased.

scottilee · 2019-12-22T20:11:47Z

CONTRIBUTING.md

+
+### Windows Developers
+
+The symbolic links contained in this repo does not work for Windows operating systems. If you are a Windows developer, please run the [fix](scripts/windows-setup-fix.bat) inside the scripts folder or manually copy the content of the [kubernetes/base](https://github.com/kubernetes-client/python-base) folder into the [kubernetes](kubernetes) folder.


minor nitpick: "does not work" should be "do not work".

kubernetes/base -> kubernetes-client/python-base

Thanks! All other comments look good to me, but the kubernetes/base folder is what the Windows development sees after they clone the repo. This part is unchanged.

scottilee · 2019-12-22T20:15:29Z

CONTRIBUTING.md

+
+### Writing Tests
+
+In addition to running the your fix yourself and tell us that your fix works, you can demonstrate that your fix really works by using unit tests and end to end tests. These unit tests are mainly located in three places. You should put your tests into the places that they fit in.


Typo: "In addition to running the your fix yourself and tell us..."

Suggestion: "In addition to running the fix yourself, you can demonstrate that your fix really works by using unit tests and end to end tests. Tests are mainly located in three places: "

scottilee · 2019-12-22T20:17:36Z

CONTRIBUTING.md

+
+If you write a new end to end (e2e) test, or change behaviors that affect e2e tests, you should set up a local cluster and test them on your machine. The following steps will help you run the unit tests.
+
+1. Acquire a local cluster. [Minikube](https://github.com/kubernetes/minikube) is a good choice for Windows and Linux developers. Alternatively if you are on Linux, you can clone the [kubernetes](https://github.com/kubernetes/kubernetes) and run [install-etcd.sh](https://github.com/kubernetes/kubernetes/blob/master/hack/install-etcd.sh) and then [local-up-cluster.sh](https://github.com/kubernetes/kubernetes/blob/master/hack/local-up-cluster.sh) to get a local cluster up and running.


Where it says, "you can clone the kubernetes and..." I think you forgot to add "repo" at the end.

scottilee · 2019-12-22T20:18:28Z

CONTRIBUTING.md

+
+## Update the Base Submodule in the Main Repo After Your python-base PR Is Merged
+
+Your contribution of the base repo will not be automatically reflected in the main repo after your PR is merged. Instead, please update the ```base``` submodule in your fork of the main repo as follows:


"Your contribution of the base repo" -> "Your contribution to the base repo"

scottilee · 2019-12-22T20:19:13Z

This is awesome, it adds a lot of context and info! Added some comments.

roycaihw · 2019-12-23T19:20:45Z

/lgtm
/approve

Feel free to address comments from @scottilee and add more context in a followup PR.

k8s-ci-robot · 2019-12-23T19:20:54Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: micw523, roycaihw

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [roycaihw]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 13, 2019

k8s-ci-robot requested review from roycaihw and yliaog December 13, 2019 20:29

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 13, 2019

yliaog self-assigned this Dec 13, 2019

micw523 changed the title ~~[WIP] Add Contribution 101~~ Add Contribution 101 Dec 13, 2019

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 13, 2019

k8s-ci-robot assigned roycaihw Dec 13, 2019

Add contribution 101

a33906c

micw523 force-pushed the contrib branch from 7dfb988 to a33906c Compare December 13, 2019 21:00

roycaihw reviewed Dec 16, 2019

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

Format changes, add contents

f966677

palnabarun reviewed Dec 17, 2019

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

Change base repo update to use a single line

e16f98e

scottilee reviewed Dec 22, 2019

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 23, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 23, 2019

k8s-ci-robot merged commit 039f167 into kubernetes-client:master Dec 23, 2019

micw523 mentioned this pull request Dec 23, 2019

Grammar fixes to contributing doc #1038

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Contribution 101 #1031

Add Contribution 101 #1031

micw523 commented Dec 13, 2019 •

edited

Loading

micw523 commented Dec 13, 2019

roycaihw left a comment

scottilee Dec 22, 2019

scottilee Dec 22, 2019

scottilee Dec 22, 2019

micw523 Dec 23, 2019

scottilee Dec 22, 2019

scottilee Dec 22, 2019

scottilee Dec 22, 2019

scottilee commented Dec 22, 2019

roycaihw commented Dec 23, 2019

k8s-ci-robot commented Dec 23, 2019


		### Where to Submit Your Patch

		These folders are automatically generated. You will need to submit a patch to the upstream kubernetes repo [kubernetes](https://github.com/kubernetes/kubernetes) or the OpenAPI generator repo [openapi-generator](https://github.com/OpenAPITools/openapi-generator). This contains:


		### Windows Developers

		The symbolic links contained in this repo does not work for Windows operating systems. If you are a Windows developer, please run the [fix](scripts/windows-setup-fix.bat) inside the scripts folder or manually copy the content of the [kubernetes/base](https://github.com/kubernetes-client/python-base) folder into the [kubernetes](kubernetes) folder.


		### Writing Tests

		In addition to running the your fix yourself and tell us that your fix works, you can demonstrate that your fix really works by using unit tests and end to end tests. These unit tests are mainly located in three places. You should put your tests into the places that they fit in.


		If you write a new end to end (e2e) test, or change behaviors that affect e2e tests, you should set up a local cluster and test them on your machine. The following steps will help you run the unit tests.

		1. Acquire a local cluster. [Minikube](https://github.com/kubernetes/minikube) is a good choice for Windows and Linux developers. Alternatively if you are on Linux, you can clone the [kubernetes](https://github.com/kubernetes/kubernetes) and run [install-etcd.sh](https://github.com/kubernetes/kubernetes/blob/master/hack/install-etcd.sh) and then [local-up-cluster.sh](https://github.com/kubernetes/kubernetes/blob/master/hack/local-up-cluster.sh) to get a local cluster up and running.


		## Update the Base Submodule in the Main Repo After Your python-base PR Is Merged

		Your contribution of the base repo will not be automatically reflected in the main repo after your PR is merged. Instead, please update the ```base``` submodule in your fork of the main repo as follows:

Add Contribution 101 #1031

Add Contribution 101 #1031

Conversation

micw523 commented Dec 13, 2019 • edited Loading

micw523 commented Dec 13, 2019

roycaihw left a comment

Choose a reason for hiding this comment

scottilee Dec 22, 2019

Choose a reason for hiding this comment

scottilee Dec 22, 2019

Choose a reason for hiding this comment

scottilee Dec 22, 2019

Choose a reason for hiding this comment

micw523 Dec 23, 2019

Choose a reason for hiding this comment

scottilee Dec 22, 2019

Choose a reason for hiding this comment

scottilee Dec 22, 2019

Choose a reason for hiding this comment

scottilee Dec 22, 2019

Choose a reason for hiding this comment

scottilee commented Dec 22, 2019

roycaihw commented Dec 23, 2019

k8s-ci-robot commented Dec 23, 2019

micw523 commented Dec 13, 2019 •

edited

Loading