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

Please adhere to semantic versioning #246

Closed
AzureMarker opened this issue Mar 29, 2022 · 1 comment
Closed

Please adhere to semantic versioning #246

AzureMarker opened this issue Mar 29, 2022 · 1 comment
Labels
bug Something isn't working

Comments

@AzureMarker
Copy link

AzureMarker commented Mar 29, 2022

This project has been called out for breaking semver before:

Taking a look at the changelog, there are numerous examples of breaking changes, including renaming/moving functions and types, moving existing code to be behind feature flags, removing types, etc.

From the amount of breaking changes and the response in the previous issues, I'm not sure if this problem is being taken seriously. People are using this library in production, and the version is past 1.0, so being this cavalier about breaking changes is a red flag.

Please follow the guidelines in https://doc.rust-lang.org/cargo/reference/semver.html, https://rust-lang.github.io/rfcs/1105-api-evolution.html, and https://semver.org/spec/v2.0.0.html. The Rust ecosystem relies on people to follow these guidelines to avoid breaking downstream user code (like in the linked issues).

Expected Behavior

Upgrading from 1.0.8 to latest 1.x.x version does not break my code. This is explicitly called out and promised in the changelog:

and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

Actual Behavior

There were multiple breaking changes made between minor and even patch versions. This project does not adhere to semantic versioning.

Steps to Reproduce the Problem

See for example the work done in this PR, to upgrade from 1.0.8: pyrossh/rust-embed#173

Specifications

N/A

@AzureMarker AzureMarker added the bug Something isn't working label Mar 29, 2022
@sunli829
Copy link
Collaborator

It won't happen again. 😂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants