Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CHANGELOG missing #242

Open
andreasabel opened this issue Dec 20, 2023 · 2 comments
Open

CHANGELOG missing #242

andreasabel opened this issue Dec 20, 2023 · 2 comments

Comments

@andreasabel
Copy link

Please add a changelog.

@freizl
Copy link
Owner

freizl commented Dec 20, 2023

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

@andreasabel
Copy link
Author

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:

  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.)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants