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

Provide Changelog #251

Open
alesn opened this issue Jul 24, 2020 · 4 comments
Open

Provide Changelog #251

alesn opened this issue Jul 24, 2020 · 4 comments

Comments

@alesn
Copy link

alesn commented Jul 24, 2020

Hi, thank you for this otherwise good widget but can you provide - maintain - Changelog for it (or include relevant information in Releases). Without it every user of your package has to go through all your commits in this repository to figure out what has changed between versions if they don't want to be surprised that something broke because something changed without them knowing about it. Thank you

@blueimp
Copy link
Owner

blueimp commented Jul 26, 2020

Hi @alesn,
I acknowledge the benefits of writing a proper changelog.
On one of my other projects, someone also recommended https://keepachangelog.com/en/1.0.0/, which has good recommendations and ideas on how to reduce the overhead of keeping one.
I've marked this as an enhancement, but will only start writing one when I'm willing to invest the time to go beyond just copying the git log.

@alesn
Copy link
Author

alesn commented Jul 26, 2020

Hi @blueimp,
Thank you. Keeping some form of a changelog can be useful even for the one writing it. It helps to keep more focused on the thing.
If you don't want to put any more work into it than just necessary, don't copy git log. That is available to everyone on Github. Then document only breaking changes that you make between versions and possibly new features / options that you add (i.e. when you are changing something about the API or in how the gallery gets used)

@blueimp
Copy link
Owner

blueimp commented Jul 27, 2020

I think focusing on the breaking changes only as a start is a good suggestion, thanks. ☺️

@sebastian-marinescu
Copy link

Hi @blueimp, would you be willing to use something like https://github.com/cookpete/auto-changelog ?

If so, I could probably provide you with a PR.

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

3 participants