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

Please add a changelog #113

Open
merwok opened this issue Feb 28, 2018 · 5 comments
Open

Please add a changelog #113

merwok opened this issue Feb 28, 2018 · 5 comments

Comments

@merwok
Copy link

merwok commented Feb 28, 2018

Hello! There is no information about the changes contained in a release.

A short list included in the README and/or PyPI description and/or github «release» tab would be great.

Thanks!

@alanjds
Copy link
Owner

alanjds commented Mar 1, 2018

Yeah, we should have a CHANGELOG file, in my opinion.

But how to maintain it? Do you now some automated way to generate a summary of the changes? If so, I could run on Travis or locally before tagging each release.

@c17r
Copy link
Collaborator

c17r commented Mar 1, 2018

zest.releaser https://github.com/zestsoftware/zest.releaser will update a history/changes file

@merwok
Copy link
Author

merwok commented Mar 1, 2018

For small projects I just look at the list of commits between tags and copy the info from the PR merge commits into the readme.

@gilmrjc
Copy link

gilmrjc commented Apr 4, 2018

Take a look on https://keepachangelog.com, it's better to do it manually instead of automatically

@merwok
Copy link
Author

merwok commented Jul 25, 2024

🤷🏽 it’s better to have something than nothing, waiting for perfection

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

4 participants