You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/specs-defs/includes/bicep/shared/non-functional/BCPNRF22.md
+18-12Lines changed: 18 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,26 +40,30 @@ For each new version, an entry **MUST** be created above all existing versions i
40
40
41
41
### Changes
42
42
43
-
- this changed
44
-
- and this also
43
+
- This changed
44
+
- And this also
45
45
46
46
### Breaking Changes
47
47
48
-
- none
48
+
- None
49
49
```
50
50
51
51
Each version's entry:
52
52
53
-
-**MUST** contain two sections: `Changes` and `Breaking Changes`. At least one of them must have a meaningful entry and sections must not be left empty. A `- none` may be added as content for a section.
53
+
-**MUST** contain two sections: `Changes` and `Breaking Changes`. At least one of them must have a meaningful entry and sections must not be left empty. A `- None` may be added as content for a section.
54
54
-**MUST** exist only once.
55
+
- All versions appear in descending order, which puts the most recent changes at the top.
55
56
56
-
All versions appear in decending order, which puts the most recent changes at the top.
57
+
What **SHOULD** be listed in the (Breaking) Changes section:
57
58
58
-
{{% notice style="note" %}}
59
+
- Relevant changes for the module
60
+
- Changes in tests do *not* need to be added
59
61
60
-
The versioning is following the [SNFR17 - Semantic Versioning]({{% siteparam base %}}/spec/SNFR17/) spec.
62
+
{{% notice style="note" %}}
63
+
64
+
The versioning is following the [SNFR17 - Semantic Versioning]({{% siteparam base %}}/spec/SNFR17/) spec.
61
65
62
-
{{% /notice %}}
66
+
{{% /notice %}}
63
67
64
68
### Example content of the CHANGELOG.md
65
69
@@ -78,7 +82,7 @@ The latest version of the changelog can be found [here](/Azure/bicep-registry-mo
78
82
79
83
### Breaking Changes
80
84
81
-
- none
85
+
- None
82
86
83
87
## 0.2.0
84
88
@@ -100,16 +104,18 @@ The latest version of the changelog can be found [here](/Azure/bicep-registry-mo
100
104
101
105
### Breaking Changes
102
106
103
-
- none
107
+
- None
104
108
105
109
```
106
110
111
+
Each bullet point should start with a capital letter.
112
+
107
113
### Manual Editing
108
114
109
115
It is possible to modify the changelog content any time, e.g., to add missing versions, which will not create a new release of the module itself. Please note the following requirements in all cases:
110
116
111
-
-all versions in the file, need to be valid and available as published version
112
-
-every version needs the two sections `## Changes` and `## Breaking Changes` with content
117
+
-All versions in the file, need to be valid and available as published version
118
+
-Every version needs the two sections `## Changes` and `## Breaking Changes` with content
0 commit comments