Add type element to contributing-wiki (#674)

* add type element * Update Contributing.md --------- Co-authored-by: Jack Tracey <[email protected]>
Azure · Nov 5, 2023 · 87e138c · 87e138c
1 parent 647f69f
commit 87e138c
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/docs/wiki/Contributing.md b/docs/wiki/Contributing.md
@@ -77,6 +77,7 @@ Throughout the development of Bicep code you should follow the [Bicep Best Pract
 
 - Strict `camelCasing` must be used for all elements:
   - Symbolic names for:
+    - Types
     - Parameters
     - Variables
     - Resource
@@ -102,6 +103,7 @@ Throughout the development of Bicep code you should follow the [Bicep Best Pract
 
 | Element Type | Naming Prefix | Example                                                              |
 | :----------: | :-----------: | :------------------------------------------------------------------- |
+|    Types     |     `typ`     | `typCustomRole`, `typSubnetOptions`                                  |
 |  Parameters  |     `par`     | `parLocation`, `parManagementGroupsNamePrefix`                       |
 |  Variables   |     `var`     | `varConditionExpression`, `varIntermediateRootManagementGroupName`   |
 |  Resources   |     `res`     | `resIntermediateRootManagementGroup`, `resResourceGroupLogAnalytics` |
@@ -122,7 +124,7 @@ For all Bicep files created as part of this project they will follow the structu
 
 ![Bicep File Structure By Element Type Image](media/bicep-structure.png)
 
-> Parameters, Variables, Resources, Modules & Outputs are all types of elements.
+> Types, Parameters, Variables, Resources, Modules & Outputs are all types of elements.
 
 ### Bicep File Structure Example
 
@@ -132,9 +134,16 @@ Below is an example of Bicep file complying with the structure and styling guide
 // SCOPE
 targetScope = 'subscription' //Deploying at Subscription scope to allow resource groups to be created and resources in one deployment
 
+// METADATA
+metadata name = 'ALZ Bicep - Example Module'
+metadata description = 'ALZ Bicep Module used as an example'
+
+// TYPES
+@minValue(0)
+type typExampleNonNegativeInteger = int
 
 // PARAMETERS
-@sys.description('Example description for parameter. - DEFAULT VALUE: "TEST"')
+@sys.description('Example description for parameter.') // Avoid describing default values
 param parExampleResourceGroupNamePrefix string = 'TEST'