search

Azure / Azure-Verified-Modules

Azure Verified Modules (AVM) is an initiative to consolidate and set the standards for what a good Infrastructure-as-Code module looks like. Modules will then align to these standards, across languages (Bicep, Terraform etc.) and will then be classified as AVMs and available from their respective language specific registries.
https://aka.ms/AVM
MIT License
345 stars 81 forks source link

[Documentation Update]: Enhance Bicep Contribution Flow Step 4 (reduce assumptions of knowledge) #1600

Open jtracey93 opened 3 days ago

jtracey93 commented 3 days ago

Check for previous/existing GitHub issues

Description

In Step 4 of the Bicep Contribution Flow there is a lot of assumption that the consumer is aware exactly what to do.

This section should be updated to include more basic/clear step by step high level steps like:

  1. Add new your modules GitHub actions workflow file to your forks main branch
  2. then create a branch
  3. then create the module directory
  4. then run set-AVM module …
  5. etc.

Just to help contributors feel less overwhelmed and confused 👍

Cc: @matebarabas

microsoft-github-policy-service[bot] commented 3 days ago

[!IMPORTANT] The "Needs: Triage :mag:" label must be removed once the triage process is complete!

[!TIP] For additional guidance on how to triage this issue/PR, see the AVM Issue Triage documentation.

matebarabas commented 1 hour ago

@ReneHezser, let's add this to our list too. Thanks!