0b81c6a6c4
tests/scripts/ansible-lint.sh was written on the doc, but there was not such file actually. We can use ansible-lint command to check ansible yml files without any options. This updates to use the command.
32 lines
1.6 KiB
Markdown
32 lines
1.6 KiB
Markdown
# Contributing guidelines
|
|
|
|
## How to become a contributor and submit your own code
|
|
|
|
### Environment setup
|
|
|
|
It is recommended to use filter to manage the GitHub email notification, see [examples for setting filters to Kubernetes Github notifications](https://github.com/kubernetes/community/blob/master/communication/best-practices.md#examples-for-setting-filters-to-kubernetes-github-notifications)
|
|
|
|
To install development dependencies you can use `pip install -r tests/requirements.txt`
|
|
|
|
#### Linting
|
|
|
|
Kubespray uses `yamllint` and `ansible-lint`. To run them locally use `yamllint .` and `ansible-lint`
|
|
|
|
#### Molecule
|
|
|
|
[molecule](https://github.com/ansible-community/molecule) is designed to help the development and testing of Ansible roles. In Kubespray you can run it all for all roles with `./tests/scripts/molecule_run.sh` or for a specific role (that you are working with) with `molecule test` from the role directory (`cd roles/my-role`).
|
|
|
|
When developing or debugging a role it can be useful to run `molecule create` and `molecule converge` separately. Then you can use `molecule login` to SSH into the test environment.
|
|
|
|
#### Vagrant
|
|
|
|
Vagrant with VirtualBox or libvirt driver helps you to quickly spin test clusters to test things end to end. See [README.md#vagrant](README.md)
|
|
|
|
### Contributing A Patch
|
|
|
|
1. Submit an issue describing your proposed change to the repo in question.
|
|
2. The [repo owners](OWNERS) will respond to your issue promptly.
|
|
3. Fork the desired repo, develop and test your code changes.
|
|
4. Sign the CNCF CLA (<https://git.k8s.io/community/CLA.md#the-contributor-license-agreement>)
|
|
5. Submit a pull request.
|