petervanderdoes
Improve changelog and release
Problem
Thanks for the useful git flow, I use it a lot in my projects. :+1:
This issue is not about a problem in the scripts itself, but an idea of how to improve the changelog of this project.
I've noticed the CHANGELOG.md file and the releases tab. They contain basically the same information as far as I can see.
It's very helpful to have a changelog file. I know it's hard and sometimes a very cumbersome work to collect all information. However, I see basically one problem with the current state:
The changelog entries doesn't refer to any issue numbers (or commit hashes)—it should, IMHO.
As such, it is hard to investigate which changelog line corresponds to which issue. Sure, you can use git log and read the history, but IMHO it should be easier.
Suggested Solution
As an example, the DAPS project contains a section about bugfixes and their issue numbers. Luckily, GitHub creates nice links for every issue number if you write it as #NUMBER. Whoever reads a tagged version in GitHub can easily follow the related issue.
I'm not so concerned about the format, it's more that this vital information should be available. :wink: If you need some inspiration, I'd recommend https://keepachangelog.com/en/.
Thanks and keep up the good work! :+1:
