Skip to content

Commit 61b2945

Browse files
authored
feat: changelog entries should start with capital letters (#2125)
1 parent 36366b3 commit 61b2945

1 file changed

Lines changed: 18 additions & 12 deletions

File tree

  • docs/content/specs-defs/includes/bicep/shared/non-functional

docs/content/specs-defs/includes/bicep/shared/non-functional/BCPNRF22.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,26 +40,30 @@ For each new version, an entry **MUST** be created above all existing versions i
4040
4141
### Changes
4242
43-
- this changed
44-
- and this also
43+
- This changed
44+
- And this also
4545
4646
### Breaking Changes
4747
48-
- none
48+
- None
4949
```
5050

5151
Each version's entry:
5252

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.
5454
- **MUST** exist only once.
55+
- All versions appear in descending order, which puts the most recent changes at the top.
5556

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:
5758

58-
{{% notice style="note" %}}
59+
- Relevant changes for the module
60+
- Changes in tests do *not* need to be added
5961

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.
6165

62-
{{% /notice %}}
66+
{{% /notice %}}
6367

6468
### Example content of the CHANGELOG.md
6569

@@ -78,7 +82,7 @@ The latest version of the changelog can be found [here](/Azure/bicep-registry-mo
7882
7983
### Breaking Changes
8084
81-
- none
85+
- None
8286
8387
## 0.2.0
8488
@@ -100,16 +104,18 @@ The latest version of the changelog can be found [here](/Azure/bicep-registry-mo
100104
101105
### Breaking Changes
102106
103-
- none
107+
- None
104108
105109
```
106110

111+
Each bullet point should start with a capital letter.
112+
107113
### Manual Editing
108114

109115
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:
110116

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
113119

114120
{{% notice style="note" %}}
115121

0 commit comments

Comments
 (0)