Skip to content

Commit 8213589

Browse files
committed
Clear release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 1350daf commit 8213589

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

RELEASE_NOTES.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
11
# Frequenz Repository Configuration Release Notes
22

3-
## Bug Fixes
3+
## Summary
4+
5+
<!-- Here goes a general summary of what this release is about -->
46

5-
- Update the version used in the documentation.
7+
## Upgrading
8+
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
610

711
### Cookiecutter template
812

9-
- Update the generated version in dependencies.
10-
- Exclude `benchmarks/` directory from source distribution.
11-
- Use the native `navigation.indexes` extension from `mkdocs-material` instead of the `section-indexes` plugin.
13+
<!-- Here upgrade steps for cookiecutter specifically -->
14+
15+
## New Features
16+
17+
<!-- Here goes the main new features and examples or instructions on how to use them -->
18+
19+
### Cookiecutter template
20+
21+
<!-- Here new features for cookiecutter specifically -->
22+
23+
## Bug Fixes
24+
25+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
26+
27+
### Cookiecutter template
1228

13-
The plugin had some issues when failing to keep up to date.
29+
<!-- Here bug fixes for cookiecutter specifically -->

0 commit comments

Comments
 (0)