Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

semver + CHANGELOG.md #16

Open
taoeffect opened this issue Sep 20, 2014 · 7 comments
Open

semver + CHANGELOG.md #16

taoeffect opened this issue Sep 20, 2014 · 7 comments
Labels
Milestone

Comments

@taoeffect
Copy link

Could you please start tracking changes and follow semver?

@dcharbonnier
Copy link
Collaborator

What is the problem with the version ? 0.8.1 is correct

@taoeffect
Copy link
Author

It doesn't follow semver, there were breaking API changes, so it should be at 1.x now (after the breaking change).

@pocesar
Copy link
Owner

pocesar commented Sep 20, 2014

hey @taoeffect what break?

@taoeffect
Copy link
Author

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.

@taoeffect
Copy link
Author

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).

@pocesar
Copy link
Owner

pocesar commented Sep 20, 2014

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)

@pocesar pocesar added this to the 2.0 milestone Oct 4, 2016
@pocesar
Copy link
Owner

pocesar commented Oct 4, 2016

need to implement a proper CHANGELOG and report every breaking change (end user and implementors)

@pocesar pocesar added the bug label Oct 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants