Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 3.73 KB
Raw

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.

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.

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 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, especially the section on configuration for cloud tests. For questions about writing tests the Ansible Kubernetes community can be found on Libera.Chat IRC as detailed below.

Updating documentation

Modules and plugins documentation is autogenerated using collection_prep_add_docs command from 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.

Code of Conduct

The kubernetes.core collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

IRC

Our IRC channels may require you to register your nickname. If you receive an error when you connect, see Libera.Chat's Nickname Registration guide for instructions.

The #ansible-kubernetes channel on libera.chat IRC is the main and official place to discuss use and development of the kubernetes.core collection.

For more information about Ansible's Kubernetes integration, browse the resources in the Kubernetes Working Group Community wiki page.