c941d74b37
As discussed, Python modules which aren't intended to be invoked as scripts should not include a shebang line. Update CONTRIBUTING.md and the checker script. This script now includes a list SKIP_FILES for files that should not be checked for boilerplate template. The tests will now fail if a Python module has a shebang line. Scripts which should have a shebang line and exists in the directory `hack` can be ignored by adding them to the SKIP_FILES list.
30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
# Contributing
|
|
|
|
Thanks for taking the time to join our community and start contributing!
|
|
|
|
Any changes to utilities in this repo should be send as a PR to this repo.
|
|
After the PR is merged, developers should create another PR in the main repo to update the submodule.
|
|
See [this document](https://github.com/kubernetes-client/python/blob/master/devel/submodules.md) for more guidelines.
|
|
|
|
The [Contributor Guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md)
|
|
provides detailed instructions on how to get your ideas and bug fixes seen and accepted.
|
|
|
|
Please remember to sign the [CNCF CLA](https://github.com/kubernetes/community/blob/master/CLA.md) and
|
|
read and observe the [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
|
|
|
|
## Adding new Python modules or Python scripts
|
|
If you add a new Python module please make sure it includes the correct header
|
|
as found in:
|
|
```
|
|
hack/boilerplate/boilerplate.py.txt
|
|
```
|
|
|
|
This module should not include a shebang line.
|
|
|
|
If you add a new Python helper script intended for developers usage, it should
|
|
go into the directory `hack` and include a shebang line `#!/usr/bin/env python`
|
|
at the top in addition to rest of the boilerplate text as in all other modules.
|
|
|
|
In addition this script's name should be added to the list
|
|
`SKIP_FILES` at the top of hack/boilerplate/boilerplate.py.
|