Skip to content

feat: changelog entries should start with capital letters #2125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReneHezser merged 2 commits into from
Jun 12, 2025
Merged

feat: changelog entries should start with capital letters #2125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
060012f
changelog entries should start with capital letters
ReneHezser Jun 12, 2025
786b43b
Updates the content requirements
ReneHezser Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions docs/content/specs-defs/includes/bicep/shared/non-functional/BCPNRF22.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,26 +40,30 @@ For each new version, an entry **MUST** be created above all existing versions i

### Changes

- this changed
- and this also
- This changed
- And this also

### Breaking Changes

- none
- None
```

Each version's entry:

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

All versions appear in decending order, which puts the most recent changes at the top.
What **SHOULD** be listed in the (Breaking) Changes section:

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

The versioning is following the [SNFR17 - Semantic Versioning]({{% siteparam base %}}/spec/SNFR17/) spec.
{{% notice style="note" %}}

The versioning is following the [SNFR17 - Semantic Versioning]({{% siteparam base %}}/spec/SNFR17/) spec.

{{% /notice %}}
{{% /notice %}}

### Example content of the CHANGELOG.md

Expand All @@ -78,7 +82,7 @@ The latest version of the changelog can be found [here](/Azure/bicep-registry-mo

### Breaking Changes

- none
- None

## 0.2.0

Expand All @@ -100,16 +104,18 @@ The latest version of the changelog can be found [here](/Azure/bicep-registry-mo

### Breaking Changes

- none
- None

```

Each bullet point should start with a capital letter.

### Manual Editing

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:
Comment thread
eriqua marked this conversation as resolved.

- all versions in the file, need to be valid and available as published version
- every version needs the two sections `## Changes` and `## Breaking Changes` with content
- All versions in the file, need to be valid and available as published version
- Every version needs the two sections `## Changes` and `## Breaking Changes` with content

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

Expand Down