Add a changelog

[peso]

When projects live on for several releases, users want to see what has happened since last time they upgraded.

This can be solved by simply adding a CHANGELOG.md file.

To make it easy to use and maintain, I suggest it should follow the principles described at https://keepachangelog.com/en/

[mlange-42]

Yes, we should definitely add a changelog with the next release! Besides informing users about changes, it would also give contributors a bit more visibility, as I would add authors for each PR that is not from me.

Usually, I use different categories than the text you linked (breaking changes, features, documentation, performance, bug fixes, other), but be can discuss this. We should also keep in mind that git-graph is both a CLI tool and a library.

[peso]

@mlange-42 will you look into this, or should I create one?

[alerque]

Agree a changelog would be good, and also agree with keepachangelog in that just dumping a git log is bad. But if the project were to follow some sort of semantic commit guidelines (e.g. Conventional Commits) then a changelog generator (e.g. git cliff) can be used to filter and organize the relevant bits of the commit log into an actually useful changelogs. It is a little more work up front at commit (or PR merge) time to make sure the commit messages are correct, but it makes the subsequent release process a complete no-brainer with no overhead required to have nice things like changelogs.