CONTRIBUTING.md

Contributing

This document provides guidelines for contributing to the module.

Dependencies

The following dependencies must be installed on the development system:

• Terraform

Azure

• Terraform Provider for Azure
• CLI Tool az

AWS

• Terraform Provider for AWS
• CLI Tool aws-cli

GCP

• Terraform Provider for GCP
• Terraform Provider for GCP Beta
• CLI Tool gcloud

Generating Documentation for Inputs and Outputs

The Inputs and Outputs tables in the READMEs of the root module, submodules, and example modules are automatically generated based on the variables and outputs of the respective modules. These tables must be refreshed if the module interfaces are changed.

This can be achieved by using terraform-docs

terraform-docs markdown ./terraform-module-name

Integration Testing

Integration tests are used to verify the behaviour of the root module, submodules, and example modules. Additions, changes, and fixes should be accompanied with tests.

Test are located in folder tests

Linting and Formatting

Many of the files in the repository can be linted or formatted to maintain a standard of quality using terraform fmt