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

Describe API stability guarantees in README and docs.rs #968

Open
Lorak-mmk opened this issue Mar 20, 2024 · 1 comment
Open

Describe API stability guarantees in README and docs.rs #968

Lorak-mmk opened this issue Mar 20, 2024 · 1 comment
Labels
API-stability Part of the effort to stabilize the API documentation Improvements or additions to documentation
Milestone

Comments

@Lorak-mmk
Copy link
Collaborator

As we move towards 1.0 we must think what the term "API-stability" will mean in our case - as there is a lot of space for maintainers decision left by Rust's guidelines ( https://doc.rust-lang.org/cargo/reference/semver.html#trait-new-default-item )
What we should decide and document:

  • Which possibly-breaking changes from guidelines are we treating as major and which as minor?
  • What is part of the API - what behaviors do we consider stable and which do we not? E.g. uniqueness of targets returned by DefaultPolicy is an example of such behavior.
  • Do we guarantee stability of default config values in SessionBuilder / Query etc? I think we should not.
  • Do we consider all Cargo features provided by crate stable? Or is it possible for them to be removed / replaced (e.g. in the case of dependency features like secrecy08).
  • Supported versions of Scylla and Cassandra. Also, do we consider dropping support for some version a breaking change?
  • How often are we willing to consider releasing a new major version (e.g. not more often than every 3 years). We probably need to include the possibility of bypassing this policy because of breaking change required by new version of Cassandra / Scylla (Tablets is an example of such change).
@Lorak-mmk Lorak-mmk added this to the 1.0.0 milestone Mar 20, 2024
@Lorak-mmk
Copy link
Collaborator Author

to consider: exclude plans returned from DefaultPolicy from API stability. Context: #969

@wprzytula wprzytula added documentation Improvements or additions to documentation API-stability Part of the effort to stabilize the API labels Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API-stability Part of the effort to stabilize the API documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants