Release notes re: breaking changes?

negomi / react-burger-menu

:hamburger: An off-canvas sidebar component with a collection of effects and styles using CSS transitions and SVG path animations

http://negomi.github.io/react-burger-menu/

MIT License

5.04k stars 582 forks source link

Open dannyshaw opened 3 years ago

dannyshaw commented 3 years ago

Hey just wondering if there's a change log anywhere? Some notes for breaking changes at minimum would be super helpful for major version bumps.

I've been hunting through commits looking for reasons for the major change to 3 that I should know about.

It looks like perhaps the use of hooks making the React version minimum is perhaps the only issue? https://github.com/negomi/react-burger-menu/commit/eb951e6c99c89133d5292c1f7fefe825d4def945

negomi commented 3 years ago

Hey @dannyshaw,

There actually isn't a changelog (I really should add one, just never got around to it).

You're correct, the upgrade from 2 to 3 didn't include any breaking changes other than the switch to hooks.

I'm not doing too much active development on this project anymore but I'll leave this open as a reminder to implement a changelog anyway :)