search

KyleAMathews / react-headroom

Hide your header until you need it
https://kyleamathews.github.io/react-headroom
MIT License
1.84k stars 149 forks source link

Please add a Changelog.md or similar #170

Open natterstefan opened 5 years ago

natterstefan commented 5 years ago

Hi @KyleAMathews,

first of all, thanks for the module. I appreciate your work and effort (and also from all the other contributors).

One question though, can you add a changelog (eg. Changelog.md) or at least add more details to the releases tags in Github (your latest release tag compared with an example), anything that can help us to see the progress, breaking changes and other notes about new versions, please?

That would be very helpful when one decides to upgrade your module or not. Because comparing it by ourselves doesn't solve the issue IMHO. I don't wanna do this by myself with every release.

For instance, you deployed 3.0.0 a few days ago, and I am still on 2.2.8. Now, I ask myself: are there any breaking changes (2.x->3.x) that caused the major release, or are there no breaking ones.

Thank you very much.

PS: FTR, there are two descriptive release-tags (example), but that's it, unfortunately.

rafaelalmeidatk commented 5 years ago

FWIW, the major increase was due to #168. It will only be an issue if you are utilizing a React version previous than 16.3.0.

natterstefan commented 5 years ago

Thanks @rafaelalmeidatk.

endymion1818 commented 4 years ago

Thanks @natterstefan ill look into this

natterstefan commented 4 years ago

Thank you @endymion1818.