Changelog

[mateja176]

When upgrading to a major version, it would be really helpful to be able to reference a changelog. As to how the changelog is structured, create-react-app's changelog serves as a great example. More specifically, panzoom is at version ^8 in one of my repos and I wonder what the benefits are to upgrading to version 9.

[anvaka]

Agreed, I need better culture around change log generation.

I strictly follow the tagging rule, so every version on npm has corresponding tag in the repository. You can generate the changelog by running:

git log v8.7.0..v9.2.1 --pretty=format:"%s [view commit](http://github.com/anvaka/panzoom/commit/%H)"

Here is what I've got:

9.2.1 view commit

• respect custom controller's ctm on touch end view commit

9.2.0 view commit

• rebuild view commit
• Merge pull request Public setter for minZoom and maxZoom properties #168 from TrinTragula/master view commit
• Public zetter for minZoom and maxZoom view commit

9.1.0 view commit

• Allow to adjust zoom speed view commit

9.0.0 view commit

• Account for delta speed during mouse wheel view commit

8.7.5 view commit

• Added disableKeyboardInteraction definition view commit

8.7.4 view commit

• rebuild view commit
• patching firefox svg transformation matrix view commit
• update fiddle link view commit
• updated versions view commit

8.7.3 view commit

• Fixed screen transformation for svg view commit
• changed the title view commit
• explicitly marking events as not passive view commit
• updated links view commit

8.7.2 view commit

• Fixed center point of pinch zoom view commit
• added html tag view commit

8.7.1 view commit

• Release text selection interceptor when paused view commit
• Refactored how text selection is checked view commit
• Version view commit
• updated variable name view commit
• small clean up view commit
• Handle burst panning view commit
• removed window dependency from kinetic view commit
• updated js style view commit
• Made consistent styles view commit

[mateja176]

Thank you very much for the insight. However still can't conclude what the breaking change/s are between version 8 and version 9. Moreover, looking at the log, I'd assume that it is the following commit:

9.0.0 view commit

Account for delta speed during mouse wheel view commit

However, when going through the changes associated with this commit I haven't spotted any breaking change. Is there something that I missed?

[anvaka]

The breaking change is in the user experience. It is especially noticeable when using touch scroll on OSX - prior to v9.0.0 the zoom was monotonous, starting from v9.0.0 it scale more naturally, proportionally to the amount of scroll events.

You would also notice change when you use a firefox browser on windows machine

[mateja176]

I don't have either a OSX or Windows machine, but I can imagine that the impact is significantly positive. On the other hand, I successfully upgraded the library in my project. Moreover, I cautiously approached the upgrade because I expected a breaking change to the API. It's funny because sometimes breaking changes slip through in minor or even patch version updates and regenerating the package-lock may lead to numerous runtime errors, which is not in accordance to semantic versioning. However, in this case the breaking change didn't actually break anything, it is however a UX improvement. Hence, do you think that the update could have been released with a minor version increase?