You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-14
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Follow either of the two links above to access the appropriate CLA and instructi
15
15
16
16
## Composition of This Repository and Where/How to Contribute
17
17
18
-
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.
18
+
The Kubernetes Python client contains mostly files that are generated by the OpenAPI generator from [this OpenAPI spec](scripts/swagger.json). In the repo there is also the utility part, which allows developers to create their own kubernetes clients ([kubernetes/base](kubernetes/base)). The base repo was once a submodule of the main repo, but is now integrated into the main repo. The archived code is available ([here](https://github.com/kubernetes-client/python-base)).
19
19
20
20
### Where to Submit Your Patch
21
21
@@ -25,16 +25,17 @@ The following folders are automatically generated. You will need to submit a pat
25
25
-[kubernetes/docs](kubernetes/docs).
26
26
27
27
In this main repo, the following folders contain developer written codes and the patches should be submitted as pull requests here:
The following folders and symbolic links in this main repo are in fact from the base repo. The base repo contains developer written codes only. The patches should be sent to the base repo instead:
34
-
- kubernetes/base
35
-
- kubernetes/config
36
-
- kubernetes/stream
37
-
- kubernetes/watch.
38
39
39
40
### Contributing A Patch
40
41
@@ -79,11 +80,3 @@ If you write a new end to end (e2e) test, or change behaviors that affect e2e te
79
80
2. Run the unit tests. In the root directory of the main repo, run ```python -m unittest discover```.
80
81
81
82
3. Check the test results and make corresponding fixes.
82
-
83
-
## Update the Base Submodule in the Main Repo After Your python-base PR Is Merged
84
-
85
-
Your contribution to 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:
86
-
```bash
87
-
$ git submodule update --remote
88
-
```
89
-
You may now add a release note to [CHANGELOG.md](CHANGELOG.md) if needed and then commit and push to your fork. You can now send a PR to this main repo to complete your contribution.
0 commit comments