feat: add BCPNFR15 to include AVM module issue template update guidel…

…ines (#549)
Azure · Jan 24, 2024 · 08f2a1e · 08f2a1e
1 parent 39c7d4a
commit 08f2a1e
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/docs/content/help-support/issue-triage/avm-issue-triage.md b/docs/content/help-support/issue-triage/avm-issue-triage.md
@@ -116,6 +116,7 @@ Although, it's not directly part of the module proposal triage process, to begin
     - Look for the module owners confirmation on the related `[Module Proposal]` issue that they have created the required `-module-owners-` and `-module-contributors-` GitHub teams.
     - Ensure the `-module-owners-` and `-module-contributors-` GitHub teams have been assigned to their respective parent teams as outlined [here](https://azure.github.io/Azure-Verified-Modules/specs/shared/#grant-permissions---bicep).
     - Ensure the [`CODEOWNERS`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/CODEOWNERS) file in the [BRM repo](https://aka.ms/BRM) has been updated.
+    - Ensure the [`AVM Module Issue template`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/ISSUE_TEMPLATE/avm_module_issue.yml) file in the [BRM repo](https://aka.ms/BRM) has been updated.
 
 {{< /hint >}}
 

diff --git a/docs/content/specs/bicep/_index.md b/docs/content/specs/bicep/_index.md
@@ -327,6 +327,10 @@ For example, the `version` value should be:
 
 <br>
 
+---
+
+<br>
+
 #### ID: BCPNFR9 - Category: Testing - Expected Test Directories
 
 Module owners **MUST** create the `defaults`, `waf-aligned` folders within their `/tests/e2e/` directory in their module source code and `SHOULD` create a `max` folder also. Each folder will be used as described for various test cases.
@@ -408,6 +412,8 @@ The syntax is used by the ReadMe-generating utility to identify, pull & format u
 
 ---
 
+<br>
+
 #### ID: BCPNFR13 - Category: Testing - Test file metadata
 
 By default, the ReadMe-generating utility will create usage examples headers based on each `e2e` folder's name.
@@ -430,3 +436,38 @@ This instance deploys the module using Customer-Managed-Keys using a System-Assi
 ---
 
 <br>
+
+#### ID: BCPNFR15 - Category: Contribution/Support - AVM Module Issue template file
+
+As part of the "initial Pull Request" (that publishes the first version of the module), module owners **MUST** add an entry to the `AVM Module Issue template` file in the BRM repository ([here](https://github.com/Azure/bicep-registry-modules/blob/main/.github/ISSUE_TEMPLATE/avm_module_issue.yml)).
+
+{{< hint type=note >}}
+Through this approach, the AVM core team will allow raising a bug or feature request for a module, only after the module gets merged to the [BRM](https://aka.ms/BRM) repository.
+{{< /hint >}}
+
+The module name entry **MUST** be added to the dropdown list with id `module-name-dropdown` as an option, in alphabetical order.
+
+{{< hint type=important >}}
+Module owners **MUST** ensure that the module name is added in alphabetical order, to simplify selecting the right module name when raising an AVM module issue.
+
+{{< /hint >}}
+
+Example - `AVM Module Issue template` module name entry for the Bicep resource module of Azure Virtual Network (`avm/res/network/virtual-network`):
+
+```yaml
+- type: dropdown
+  id: module-name-dropdown
+  attributes:
+    label: Module Name
+    description: Which existing AVM module is this issue related to?
+    options:
+      ...
+      - "avm/res/network/virtual-network"
+      ...
+```
+
+<br>
+
+---
+
+<br>