Fragments for the changelog

This directory contains fragments for the future Changelog file.

Introduction

We use towncrier to produce useful, summarized news files.

There are 5 sections types:

• Model: changes/models
• Layout: changes/layouts
• Option: changes/options
• Miscellaneous: changes/misc
• Build System: changes/build

There are 3 news fragments types:

• Breaking changes: .breaking
• New: .feature
• Fixes: .bugfix

Adding a fragment

Add a short description of the change in a file changes/SECTION/ID.FRAGMENT.md, where:

• SECTION and FRAGMENT values are described in the previous section.
• ID is the corresponding issue identifier on Github, if relevant. If there is no such issue, then ID should start with + and some identifier that make the file unique in the directory.

Examples:

• A bug fix for the issue #465 is a build change, so the corresponding file should be named changes/build/465.bugfix.md.
• A new feature for options like !662 corresponds to e.g. changes/options/+add-scrolllock-mod3.feature.md.

Guidelines for the fragment files:

• Use the Markdown markup.
• Use past tense, e.g. “Fixed a segfault”.
• Look at the previous releases NEWS file for further examples.

Build the changelog

Install towncrier from Pypi:

python3 -m pip install towncrier

Then build the changelog:

# Only check the result. Useful after adding a new fragment.
towncrier build --draft --version 1.8.0
# Write the changelog & delete the news fragments
towncrier build --yes --version 1.8.0