anoma / namada-interface

Apache License 2.0
77 stars 95 forks source link

Namadillo: Decide on a changelog process #893

Open emccorson opened 2 weeks ago

emccorson commented 2 weeks ago

We should have a changelog for Namadillo and decide on how we want to do this.

My preference would be to use something like unclog (the tool the main namada team uses), which means if a PR introduces user-facing changes (for Namadillo, this means the host of Namadillo), it should add a new file in a changelog directory. Then at release time, the tool adds all changelog entries to the CHANGELOG.md file. (Alternatively, we could consider just writing a shell script for this to avoid a dependency on unclog and keep the process very simple.)

I think this will lead to better results than automatically generating a changelog based on git history. It is also better than directly writing to CHANGELOG.md, which would cause a lot of merge conflicts.

A good general guide: https://keepachangelog.com

A more specific (but possibly too restrictive) guide: https://common-changelog.org/