node-jsonrpc2
node-jsonrpc2 copied to clipboard
pocesar
semver + CHANGELOG.md
It doesn't follow semver, there were breaking API changes, so it should be at 1.x now (after the breaking change).
Err, actually... I might be wrong:
Major version zero (0.y.z) is for initial development.
Anything may change at any time. The public API should not be considered stable.
hey @taoeffect what break?
Somewhere between 0.6 and 0.8.1 dollar signs were introduces into the names of all the function calls.
Anywho, I hope that wasn't a coincidence and you guys are actually planning on following semver.
A changelog would still be nice (it's time consuming to was through the commits to figure out whether something serious changed or not).
I usually follow semver, ESClass (the dependency) had deprecated non $ since version 1.x (that was already being used in json-rpc2 long time ago). When changed dependency version to 2.x, the deprecated code was removed, but indeed is a breaking change, but there isn't a major version like you pointed out, yet. I have future plans to refactor the lib and push major versions forward, although it's kinda stable right now
I also usually use a CHANGELOG, but since I forked this lib and refactored it a lot, I forgot to keep track of the changes :) (eg: https://github.com/pocesar/ES5-Class/blob/master/CHANGELOG.md)
need to implement a proper CHANGELOG and report every breaking change (end user and implementors)