-
-
Notifications
You must be signed in to change notification settings - Fork 82
Description
Please consider adopting semantic versioning (https://semver.org/) or some other meaningful versioning standard that conveys when breaking changes are made. I'm the author and maintainer of https://www.npmjs.com/package/caniemail and the latest sets of updates are preventing us from using any kind of automated update mechanism with confidence on the data.json file.
We maintain snapshot tests for the use of data.json against fixture data. If the snapshot comparison for the test against the new data results in a mismatch with additions, we update out snapshots and release. However, missing or changed data causes a hard stop and we have to intervene manually.
Using a standardized versioning scheme for the data.json file would give us confidence in automated operations. For a patch release, we could be confidence that our snapshots could be updated, and we'd likewise issue a patch release. The same would go for feature releases. For removal (or moving to another place in the document) of rules, that would constitute a breaking (major in semver) change, and we could block the automated process for manual review.