CONTRIBUTING.md

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

• Contributing Guidelines
  • Requirements
    • Mandatory
    • Recommended
  • Local Development Setup
    • Install Visual Studio Code recommended extensions
    • Install Terraform
    • Install terraform-docs
    • Install pre-commit hooks
    • Execute pre-commit hooks manually on all files
    • Update pre-commit hooks
    • Execute tests manually
    • Upgrade providers
  • Reporting Bugs/Feature Requests
  • Contributing via Pull Requests
  • Finding contributions to work on
  • Code of Conduct
  • Security issue notifications
  • Licensing

Requirements

The following tools need to be installed on your local machine:

Mandatory

• Visual Studio Code
• pre-commit
• Terraform 1.11 or later. A version manager such as tfenv or mise helps you match the TF_VERSION that the workflows use.
• tflint
• terraform-docs 0.20.0, the version that the terraform-docs workflow runs. Other versions format the README tables differently, and the workflow fails on the difference. See Install terraform-docs.
• checkov

Recommended

• oh-my-zsh
• zsh-autosuggestions
• spaceship-prompt

Local Development Setup

Run these steps before making changes to the code. They will help automate the commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something.

Install Visual Studio Code recommended extensions

Install Visual Studio Code recommended extensions defined in .vscode/extensions.json to improve you productivity and increase code quality.

Install Terraform

Install the version set in the repository's TF_VERSION variable. For example, with tfenv:

tfenv install 1.17.0
tfenv use 1.17.0

Install terraform-docs

Install terraform-docs 0.20.0, the version in the terraform-docs workflow's action. The pre-commit hook runs the terraform-docs on your PATH. For example, with mise:

mise use --global terraform-docs@0.20.0
terraform-docs --version

Or download it from the v0.20.0 release and check it against the release's terraform-docs-v0.20.0.sha256sum file. When the workflow's action moves to a newer terraform-docs, regenerate the README with that version in the same pull request.

Install pre-commit hooks

This will ensure that the commands we want to execute before each commit are executed automatically.

pre-commit install

Execute pre-commit hooks manually on all files

# All hooks
pre-commit run --all-files

# Checkov
pre-commit run checkov --all-files

# Terraform docs
pre-commit run terraform_docs --all-files

Update pre-commit hooks

pre-commit autoupdate

Execute tests manually

The unit tests mock the AWS Provider, so they need no backend and no AWS credentials:

terraform init -backend=false
terraform test

Upgrade providers

To move to a newer provider version that the constraints in versions.tf allow, upgrade and record checksums for every platform that runs Terraform, then commit the lock file:

terraform init -backend=false -upgrade
terraform providers lock -platform=linux_amd64 -platform=linux_arm64 -platform=darwin_amd64 -platform=darwin_arm64 -platform=windows_amd64

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

• A reproducible test case or series of steps
• The version of our code being used
• Any modifications you've made relevant to the bug
• Anything unusual about your environment or deployment

Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

1. You are working against the latest source on the main branch.
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:

1. Fork the repository.
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
3. Ensure local tests pass.
4. Commit to your fork using clear commit messages.
5. Send us a pull request, answering any default questions in the pull request interface.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on forking a repository and creating a pull request.

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Security issue notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.