search

fergiemcdowall / stopword

A module for node.js and the browser that takes in text and strips it of stopwords
MIT License
231 stars 34 forks source link

Breaking changes in v3? #319

Open yelworc opened 9 months ago

yelworc commented 9 months ago

Hi, you recently published a new major version (v3.0.0), but I cannot find any corresponding documentation/changelog. More recent releases don't seem to be tagged in git either, so it's not straightforward to get a diff view of the changes.

Any release docs (e.g. a CHANGELOG.md or in GitHub releases), at least for breaking changes, would be very helpful for users of this lib :slightly_smiling_face:

fergiemcdowall commented 9 months ago

A major semver release (when the first number in the version increments, eg 2.x.x -> 3.x.x) should always be treated as a "breaking change".

That said, we should be better at documenting new releases. Thanks for the feedback, I will make a better changelog next time.