hoauth2 icon indicating copy to clipboard operation
hoauth2 copied to clipboard
verified publisher icon freizl

CHANGELOG missing

Open andreasabel opened this issue 2 years ago • 2 comments

Please add a changelog.

andreasabel avatar Dec 20 '23 18:12 andreasabel

What you do with changelog? Im trying to capture changes in the release notes. https://github.com/freizl/hoauth2/releases

freizl avatar Dec 20 '23 19:12 freizl

A changelog would summarize the important changes for the user of your library.
It would be more digested than the (semi-)auto-generated change listing, which e.g. contains entries like

  • Data.Map is probably good enough for demo-app by @freizl in https://github.com/freizl/hoauth2/pull/229
  • Refactor/update comments by @freizl in https://github.com/freizl/hoauth2/pull/225

As a user, I wouldn't know how to make sense of such entries, or wouldn't know why I should care.

There are plenty of examples for changelogs in the Haskell ecosystem.
It is helpful to put yourself into the perspective of a user: If you are using library L and it get's re-released, what changes would you like to be informed about.
I am usually interested in these questions:

  1. What are the advantages of switching to the new version (gained features, performance, correctness etc.)?
  2. What are the risks and costs of switching (API changes, incompatibilities, etc.)?

andreasabel avatar Dec 20 '23 19:12 andreasabel