Add towncrier for managing changelog #7
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds
towncrier
as a tool for managing changelog of the project.This means a few changes to the project for contributors:
prepare-release
workflow, which will automatically create the changelog from individual fragments, and remove the fragments. Only after that should a new release be made (using the standard method - pushing a release tag to main branch)For more info, a readme file was added:
changes/README.md
, explaining how this process works, along with a link to the towncrier documentation. This file was then also mentioned as required reading inCONTRIBUTING.md
.