search

blueimp / Gallery

blueimp Gallery is a touch-enabled, responsive and customizable image & video gallery, carousel and lightbox, optimized for both mobile and desktop web browsers. It features swipe, mouse and keyboard navigation, transition effects, slideshow functionality, fullscreen support and on-demand content loading.
https://blueimp.github.io/Gallery/
Other
3.75k stars 983 forks source link

Provide Changelog #251

Open alesn opened 4 years ago

alesn commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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

sebastian-marinescu commented 1 year ago

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.