search

cascornelissen / svg-spritemap-webpack-plugin

SVG spritemap plugin for webpack
MIT License
207 stars 51 forks source link

Add a CHANGELOG.md #86

Closed diverent2 closed 5 years ago

diverent2 commented 5 years ago

Hi there,

I would greatly appreciate if you could add a changelog to your project. This would help me (and others) to quickly spot changes (including breaking changes) between different versions.

Here's a guide on how to do this: keepachangelog.com ^^

Right now I'm trying to understand what was added between 3.3.x and 3.4.x to see if I can safely update my dependencies. Keeping a changelog could also help to reduce confusion like in #54.

Thank you :)

diverent2 commented 5 years ago

Update: Just saw your release page. So i'´s already there, just not where I was looking. Would still appreciate a changelog though 😉

cascornelissen commented 5 years ago

As you've sigured out already; GitHub Releases are used for the changelog which quite a lot of projects use (e.g. webpack) and I don't feel like having to do the additional work is worth the effort as most people know of the GitHub releases feature. So unless more people are running into this issue I'll leave it as it is for now.

Besides that, this plugin uses semver for its versions so as long as there's no major version change there shouldn't be any breaking changes. Also, check out a package like npm-upgrade which will find the latest versions of dependencies including changelogs for you by itself.