Prerequisites

To contribute to this project, you need to have a GitHub account which is linked to your Microsoft corporate identity account and be a member of the Azure organisation.

We recommend to use Linux or MacOS for your development environment. You can use Windows Subsystem for Linux (WSL) if you are using Windows.

To contribute to this project the following tooling is required:

• Git

  If just installed, don’t forget to set both your git username & password

  git config --global user.name "John Doe"
  git config --global user.email "johndoe@example.com"
  

• Terraform

• Azure CLI

• Visual Studio Code

  • Terraform extension for Visual Studio Code
  • EditorConfig for VS Code

• Docker

  • Azure Verified Terraform Scaffold (mcr.microsoft.com/azterraform:latest)

The following tooling/extensions are recommended to assist you developing for the project:

• Go (for writing tests)
• tfenv - useful when working on multiple modules that use different Terraform versions from the same machine

• Go extension for Visual Studio Code
• For visibility of Bracket Pairs:
  • Inside Visual Studio Code, add editor.bracketPairColorization.enabled: true to your settings.json, to enable bracket pair colorization.