Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 2.24 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Branching strategy

In general, contributors should develop on branches based off of main and pull requests should be to main.

See Understanding the GitHub flow for more information.

Submitting a pull request

  1. Clone the repository on GitHub.
  2. Create a named feature branch. (i.e. add-new-module)
  3. Write your change.
  4. Push to your branch and submit a pull request from your branch to main.

Building

Builds happen with each push to a pull request. If you want to start building right away but you aren't ready for code review you can open a Draft Pull Request. This will not notify any Reviewers that may be configured in the CODEOWNERS file until you change it to Ready for Review.

All builds for this repo can be found under the Actions tab and are also located under the Checks tab of the pull request. You may want to consider using the GitHub Slack Integration to get Slack notifications of your build status.

Releasing

Deployments are executed automatically when a pull request is merged into the main branch. Deployment status is posted to the deploy channel in Slack. You can also check the deployment status by selecting the Environments link under the Code tab.

Optional

This repo uses pre-commit for identifying simple issues before submission to code review. The following tools are required to execute the hooks. For Mac OS X you can use Homebrew and for Windows you can use Chocolatey to install.

Name OS Installation
Terraform Mac $ brew install terraform
Windows $ choco install terraform-docs
TFLint Mac $ brew install tflint
Windows $ choco install tfsec