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 file? #664

Open
tony opened this issue May 24, 2022 · 1 comment
Open

Changelog file? #664

tony opened this issue May 24, 2022 · 1 comment

Comments

@tony
Copy link

tony commented May 24, 2022

Hi! Thank you for the project!

Is it possible to have a single, curated changelog file?

What I mean by curated: changes the maintainer deems significant? (e.g. breaking changes, features, bug fixes, package updates)

I suppose it's extra upkeep, but it's prohibitively difficult (if not impossible) as a user to paginate through releases and stay on top of what changed.😢 Only the maintainer can make sense of them - and even then may eventually forget what happened

@tony
Copy link
Author

tony commented May 24, 2022

I should also say:

It's a open source after all, and I think it'd take up a lot of (more) of your time to manage a changelog file. Nobody (not me nor anyone else) is entitled to your time. Thank you once again for your project.

However, on the other hand:

I think that there's a general sustainability / practicality benefit to curating changelogs to a single file. It's more resilient to git (rather than github's proprietary way of doing things) and other potential future maintainers / contributors have a smoother time keeping up to speed. I think amortized it can save time. But fully up to you @chrisguttandin

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

No branches or pull requests

1 participant