Skip to content

Commit 4bb5c1f

Browse files
authored
more fixes and add more information
1 parent 07cddc3 commit 4bb5c1f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ The following folders are automatically generated. You will need to submit a pat
2424
- [kubernetes/test](kubernetes/test)
2525
- [kubernetes/docs](kubernetes/docs).
2626

27-
These folders contain developer written codes in the main repo and the patches should be submitted here:
27+
In this main repo, the following folders contain developer written codes and the patches should be submitted as pull requests here:
2828
- [kubernetes/e2e_test](kubernetes/e2e_test)
2929
- [kubernetes/utils](kubernetes/utils)
3030
- [examples](examples)
3131
- [scripts](scripts).
3232

33-
The base repo contains developer written codes only. The patches should be sent to the base repo instead. The scope covers these repos and symbolic links in the main repo:
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:
3434
- kubernetes/base
3535
- kubernetes/config
3636
- kubernetes/stream
@@ -50,7 +50,7 @@ If your patch depends on new packages, add those packages to [requirements.txt](
5050

5151
### Commits
5252

53-
Generally we would like to see one commit per pull request. However, if the pull request is reasonably large, the PR can be divided into several commits that make logical sense. The commit message should be clear and indicative of the aim of the fix.
53+
Generally we would like to see one commit per pull request. However, if the pull request is reasonably large, the PR can be divided into several commits that make logical sense. The commit message should be clear and indicative of the aim of the fix. Sometimes multiple commits in a single pull request is acceptable if it meets the Kubernetes [pull request guidelines](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#6-squashing-and-commit-titles).
5454

5555
If you have several commits in a pull request and have been asked to squash your commits, please use ```git reset --soft HEAD~N_COMMITS``` and commit again to make your PR a single commit.
5656

@@ -68,7 +68,7 @@ In addition to running the fix yourself and telling us that your fix works, you
6868

6969
### Coding Style
7070

71-
We use an automatic coding style checker by using the ```diff``` of the autopep8 output and your code file. To make sure that your code passes the coding style checker, run ```autopep8 --in-place --aggressive --aggressive your_code.py``` before committing and submission.
71+
We use an automatic coding style checker by using the ```diff``` of the autopep8 output and your code file. To make sure that your code passes the coding style checker, run ```autopep8 --in-place --aggressive --aggressive your_code.py``` before committing and submitting.
7272

7373
## Running Tests Locally
7474

0 commit comments

Comments
 (0)