Skip to content

NEWS formatting

Sebastian Fischer edited this page Apr 10, 2025 · 2 revisions

The recommended strategy for formatting of NEWS.md file is the following:

During development, we can simply add the commit entries as bullet points, such as:

# dev

* feat: feature A
* feat: feature B
* fix: Bug A
* fix: Bug B
...

Before making a release, we can then reformat this as follows, to give a better overview:

# dev

Features:
* feature A
* feature B

Bugfixes:
* Bug A
* Bug B