You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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:
What are the advantages of switching to the new version (gained features, performance, correctness etc.)?
What are the risks and costs of switching (API changes, incompatibilities, etc.)?
Please add a changelog.
The text was updated successfully, but these errors were encountered: