Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.72 KB

Contributing

This document provides guidelines for contributing to the module.

Contributors to this project must abide by the Contributor Covenant Code of Conduct.

File structure

The project has the following folders and files:

  • /: root folder.
  • /docs: Examples for using this module.
  • /examples: Examples for using this module.
  • /files: Static files referenced but not executed by Terraform.
  • /helpers: Helper scripts NOT called by Terraform.
  • /modules: Inline local modules called by this module.
  • /scripts: Scripts for specific tasks on module.
  • /templates: Template files used to be execute by data sources.
  • /main.tf: Main file for this module, contains all the resources to operate the module.
  • /variables.tf: All the variables necessary for run the module.
  • /output.tf: The outputs generate from the module.
  • /README.md: Main repo README document.
  • /CHANGELOG.md: Module release changelog file.
  • /CODEOWNERS: Module contributing developers.
  • /CODE_OF_CONDUCT.md: Code of Conduct file.
  • /CONTRIBUTING.md: This file.

Development

Install pre-commit with its prerequesites: python and pip.

Configure pre-commit: pre-commit install.

Install required packages: tflint, tfsec, shfmt, shellcheck, and markdownlint.

Module Documentation

The main README.md, the modules README.md and the examples README.md are populated by a terraform-docs worflow job. The following sections are appended between the terraform-docs delimeters: Requiremenents, Providers, Modules, Resources, Inputs, and Outputs.

Module Release and Changelog Generation

The module git release and changelog are generated by the release workflow job. The release worflow follows the conventional commits convention. To submit a commit, please follow the commit message format guidelines. This job is set to run manually by default.

Example commit message: fix: disabled log generation for system services

For more examples, please see conventional commit message examples.

Issues and Change Requests

Please submit change requests and / or features via Issues.