Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.75 KB
Raw

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.
  • /examples: Examples for using this module.
  • /modules: Inline local modules called by this module.
  • /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.

Adding a new module

To add a new module, fork this repo then add your module under ./modules folder. Please visit our Terraform Module Development Standards guide for more info on module development best practices.

Issues and Change Requests

Please submit change requests and / or features via Issues.

Submitting Pull Requests

Before starting any work or sending us a pull request, please ensure that:

  • Your working branch is up-to-date with the latest source on the main branch.
  • Check issues and pull requests (open/merged) to make sure someone else hasn't already addressed that issue.
  • You open an issue to discuss your proposal.

To learn how to send us a pull request, please see Contributing to Projects in the GitHub Docs.