mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-07-25 17:04:40 +00:00
e4b748a791
* CI - configure precommit hook to block commit when files from .claude/ and/or .vscode/ directories are staged
* fix sanity issue - shebang
* Remove local hook and update documentation
(cherry picked from commit a4fc40732a)
Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>
87 lines
3.4 KiB
Markdown
87 lines
3.4 KiB
Markdown
# Contributing
|
|
|
|
## Getting Started
|
|
|
|
General information about setting up your Python environment, testing modules,
|
|
Ansible coding styles, and more can be found in the [Ansible Community Guide](
|
|
https://docs.ansible.com/ansible/latest/community/index.html).
|
|
|
|
|
|
## Kubernetes Collections
|
|
|
|
### kubernetes.core
|
|
|
|
This collection contains modules and plugins contributed and maintained by the Ansible Kubernetes
|
|
community.
|
|
|
|
New modules and plugins developed by the community should be proposed to `kubernetes.core`.
|
|
|
|
## Submitting Issues
|
|
All software has bugs, and the `kubernetes.core` collection is no exception. When you find a bug,
|
|
you can help tremendously by [telling us about it](https://github.com/ansible-collections/kubernetes.core/issues/new/choose).
|
|
|
|
If you should discover that the bug you're trying to file already exists in an issue,
|
|
you can help by verifying the behavior of the reported bug with a comment in that
|
|
issue, or by reporting any additional information.
|
|
|
|
## Pull Requests
|
|
|
|
All modules MUST have integration tests for new features.
|
|
Bug fixes for modules that currently have integration tests SHOULD have tests added.
|
|
New modules should be submitted to the [kubernetes.core](https://github.com/ansible-collections/kubernetes.core) collection and MUST have integration tests.
|
|
|
|
Expected test criteria:
|
|
* Resource creation under check mode
|
|
* Resource creation
|
|
* Resource creation again (idempotency) under check mode
|
|
* Resource creation again (idempotency)
|
|
* Resource modification under check mode
|
|
* Resource modification
|
|
* Resource modification again (idempotency) under check mode
|
|
* Resource modification again (idempotency)
|
|
* Resource deletion under check mode
|
|
* Resource deletion
|
|
* Resource deletion (of a non-existent resource) under check mode
|
|
* Resource deletion (of a non-existent resource)
|
|
|
|
Where modules have multiple parameters we recommend running through the 4-step modification cycle for each parameter the module accepts, as well as a modification cycle where as most, if not all, parameters are modified at the same time.
|
|
|
|
For general information on running the integration tests see the
|
|
[Integration Tests page of the Module Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/testing_integration.html#testing-integration),
|
|
especially the section on configuration for cloud tests.
|
|
|
|
### Updating documentation
|
|
|
|
Modules and plugins documentation is autogenerated using ``collection_prep_add_docs`` command from [collection_prep](https://github.com/ansible-network/collection_prep) package.
|
|
|
|
You can install ``collection_prep`` using
|
|
|
|
# git clone https://github.com/ansible-network/collection_prep
|
|
# cd collection_prep
|
|
# pip install .
|
|
|
|
After installation, you can update documentation
|
|
|
|
# collection_prep_add_docs -p /<PATH_OF_COLLECTION>/kubernetes/core
|
|
|
|
Review the changes and create a pull request using updated files.
|
|
|
|
### Pre-Commit Hooks
|
|
|
|
To prevent accidental commits of local configuration and IDE files (specifically `.vscode/` and `.claude/`), this repository utilizes the `pre-commit` framework.
|
|
|
|
Please set up the hooks locally before making your first commit:
|
|
|
|
```bash
|
|
# Install the pre-commit tool
|
|
pip install pre-commit
|
|
|
|
# Register the hooks with Git
|
|
pre-commit install
|
|
```
|
|
|
|
### Code of Conduct
|
|
The `kubernetes.core` collection follows the Ansible project's
|
|
[Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).
|
|
Please read and familiarize yourself with this document.
|