Skip to content

Breaking Changes and Versioning? #358

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

Closed
reintroducing opened this issue Sep 4, 2019 · 2 comments
Closed

Breaking Changes and Versioning? #358

reintroducing opened this issue Sep 4, 2019 · 2 comments

Comments

@reintroducing
Copy link

Is this a question?

I'm upgrading this module in my project and I took a look at the changelog to see what changed. There are multiple entries for BREAKING yet the version did not get a major bump rather a minor. Does this project follow semantic versioning? If so, why are these changes not bumping the major version? Thanks.

Is this a bug report?

(write your answer here)

Is this a feature request?

(write your answer here)

Steps to reproduce

(Write your steps here:)

Expected behavior

(Write what you thought would happen.)

Actual behavior

(Write what happened.)

Setup

  • http-proxy-middleware: version
  • http-proxy-middleware configuration
  • server: connect/express/browser-sync... + version
  • other relevant modules

client info

target server info

Reproducible Demo

(Paste the link to an example project and exact instructions to reproduce the issue.)

@chimurai
Copy link
Owner

chimurai commented Sep 4, 2019

Hi @reintroducing ,

http-proxy-middleware does follow semver.

Think there's a common misunderstanding regarding 0.y.z versions:

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

source: https://semver.org/#spec-item-4

To avoid confusion maybe I should go for version 1.y.z?

@reintroducing
Copy link
Author

@chimurai You are right, I missed that part in the spec so thank you for clarifying. I was always under the impression that any breaking change, even in a 0.x.x release, should be breaking. They should probably update the summary at the top to just give a blurb about this in my opinion for the MAJOR portion.

Your module is used by almost 2.3 million other modules, and it would probably be a shame that others would make the same mistake I just did, but that's on me (them) for not fully reading the spec I suppose. Its entirely up to you at this point if you want to version it as major just to possibly help mitigate that confusion, but you've answered my question so I'm going to close this. Thanks again for the quick response.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants