search

pid / speakingurl

Generate a slug – transliteration with a lot of options
http://pid.github.io/speakingurl/
BSD 3-Clause "New" or "Revised" License
1.12k stars 84 forks source link

please mention breaking changes in releases #110

Closed barbalex closed 7 years ago

barbalex commented 7 years ago

Our app broke recently.

I tracked it down to speakingurl removing special characters like "!", "?". This caused conflicts in document titles in our case.

I have no idea when this change was introduced. I think it must have been introduced recently because documents only began to disappear in the last few months (judging from what users tell me).

I made it a habit to check the release messages when updating a dependency that indicates a breaking change with it's version number.

Unfortunately speakingurl does not mention what could break (for instance: https://github.com/pid/speakingurl/releases/tag/v14.0.0).

Or is there a different way to see what could break?

simison commented 7 years ago

Have you checked CHANGELOG.md?

simison commented 7 years ago

+1 for speakingurl improving on semver front.

barbalex commented 7 years ago

@simison thanks, I hadn't known that was a thing. Problem solved (although I do not see what could have caused our problems - but then we must have just not noticed them earlier I guess)