Skip to content

Commit c24de68

Browse files
committed
adjust CONTRIBUTING.md to new repo structure
1 parent c66a391 commit c24de68

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

CONTRIBUTING.md

+7-14
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Follow either of the two links above to access the appropriate CLA and instructi
1515

1616
## Composition of This Repository and Where/How to Contribute
1717

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)).
1919

2020
### Where to Submit Your Patch
2121

@@ -25,16 +25,17 @@ The following folders are automatically generated. You will need to submit a pat
2525
- [kubernetes/docs](kubernetes/docs).
2626

2727
In this main repo, the following folders contain developer written codes and the patches should be submitted as pull requests here:
28+
- [kubernetes/base](kubernetes/base)
29+
- [kubernetes/config](kubernetes/config)
30+
- [kubernetes/dynamic](kubernetes/dynamic)
2831
- [kubernetes/e2e_test](kubernetes/e2e_test)
32+
- [kubernetes/leaderelection](kubernetes/leaderelection)
33+
- [kubernetes/stream](kubernetes/stream)
2934
- [kubernetes/utils](kubernetes/utils)
35+
- [kubernetes/watch](kubernetes/watch)
3036
- [examples](examples)
3137
- [scripts](scripts).
3238

33-
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.
3839

3940
### Contributing A Patch
4041

@@ -79,11 +80,3 @@ If you write a new end to end (e2e) test, or change behaviors that affect e2e te
7980
2. Run the unit tests. In the root directory of the main repo, run ```python -m unittest discover```.
8081

8182
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

Comments
 (0)