Skip to content

Commit

Permalink
Merge pull request #1771 from jonasdlindner/contributing_fix
Browse files Browse the repository at this point in the history
Adjust CONTRIBUTING.md to new repo structure
  • Loading branch information
k8s-ci-robot committed Apr 8, 2022
2 parents 702042d + c24de68 commit 51c4816
Showing 1 changed file with 7 additions and 14 deletions.
21 changes: 7 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Follow either of the two links above to access the appropriate CLA and instructi

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

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

### Where to Submit Your Patch

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

In this main repo, the following folders contain developer written codes and the patches should be submitted as pull requests here:
- [kubernetes/base](kubernetes/base)
- [kubernetes/config](kubernetes/config)
- [kubernetes/dynamic](kubernetes/dynamic)
- [kubernetes/e2e_test](kubernetes/e2e_test)
- [kubernetes/leaderelection](kubernetes/leaderelection)
- [kubernetes/stream](kubernetes/stream)
- [kubernetes/utils](kubernetes/utils)
- [kubernetes/watch](kubernetes/watch)
- [examples](examples)
- [scripts](scripts).

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:
- kubernetes/base
- kubernetes/config
- kubernetes/stream
- kubernetes/watch.

### Contributing A Patch

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

3. Check the test results and make corresponding fixes.

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

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:
```bash
$ git submodule update --remote
```
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 comments on commit 51c4816

Please sign in to comment.