Skip to content

README.md

Latest commit

 

History

History
63 lines (43 loc) · 1.69 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.69 KB

Fragments for the changelog

This directory contains fragments for the future NEWS file.

Introduction

We use towncrier to produce useful, summarized news files.

There are 3 sections types:

  • API: changes/api
  • Tools: changes/tools
  • Build System: changes/build

There are 4 news fragments types:

  • Breaking changes: .breaking
  • Deprecated: .deprecated
  • 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 #463 is an API change, so the corresponding file should be named changes/api/463.bugfix.md.
  • A new feature for tools like #448 corresponds to e.g. changes/tools/+add-verbose-opt.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