Prerequisites

You need to have a personal GitHub account which is linked to your Microsoft corporate identity. Once the link step is complete you must join the Azure organization.

Before you start contributing to the AVM, it is highly recommended that you complete the following Microsoft Learn paths, modules & courses:

• Deploy and manage resources in Azure by using Bicep
• Structure your Bicep code for collaboration
• Manage changes to your Bicep code by using Git

• Introduction to version control with Git

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"
  

• Bicep

  Must be manually kept up-to-date.

• Pester

• Visual Studio Code

  • Bicep extension for Visual Studio Code

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

• CodeTour extension for Visual Studio Code
• ARM Tools extension for Visual Studio Code
• ARM Template Viewer extension for Visual Studio Code
• PSRule extension for Visual Studio Code
• EditorConfig for VS Code
• For visibility of Bracket Pairs:
  • Inside Visual Studio Code, add editor.bracketPairColorization.enabled: true to your settings.json, to enable bracket pair colorization.

• GitHub Desktop
  • To enhance streamlined integration during interactions with upstream repositories, GitHub Desktop will automatically configure your local git repository to use the upstream repository as a remote.