Grammar fixes to contributing doc #1038
Conversation
|
@micw523: GitHub didn't allow me to assign the following users: scottilee. Note that only kubernetes-client members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
/cc @scottilee |
|
@micw523: GitHub didn't allow me to request PR reviews from the following users: scottilee. Note that only kubernetes-client members and repo collaborators can review this PR, and authors cannot review their own PRs. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
| @@ -15,11 +15,11 @@ Follow either of the two links above to access the appropriate CLA and instructi | |||
|
|
|||
| ## 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 Kubernetes Python client consists of this main repository (repo) and the base repo, 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 base repo is a submodule of the main repo. | |||
There was a problem hiding this comment.
I'm assuming the part where it says "(repo)" should be a link? When I preview the file it's not a link.
There was a problem hiding this comment.
I'm actually saying that repo is a shorthand for repository.
CONTRIBUTING.md
Outdated
|
|
||
| ### 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. | ||
| In addition to running the 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. Tests are mainly located in three places. You should put your tests into the places that they fit in. |
|
Added some minor things but otherwise looks good to me. |
|
/approve |
|
[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:
Approvers can indicate their approval by writing |
|
/lgtm |
Subsequent fixes to #1031.
/assign @scottilee
/assign @roycaihw
More suggestions welcome!