Skip to content

Commit f47cbb4

Browse files
committed
README: Describe API stability and version support
1 parent d37162e commit f47cbb4

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,22 @@ For planned future improvements, see our [Milestones].
6868

6969
We invite you to discuss any issues and ask questions on the [ScyllaDB Forum] and the `#rust-driver` channel on [ScyllaDB Slack].
7070

71+
## Version support
72+
73+
The driver is considered production ready, hence its version is not 0.x.
74+
We do however acknowledge that the API will surely need some breaking changes in
75+
the future, which means it is not our goal to stay on 1.x forever - we will
76+
release new major version in the future.
77+
78+
The API stability guarantee we provide is that we won't release new major
79+
versions very often.
80+
In case of 2.0, it won't be released earlier than 9 months after release 1.0.
81+
For further major versions this duration may be increased.
82+
83+
After new major version is released, the previous major version will still
84+
receive bugfixes for some time (exact time is yet to be determined), but new
85+
features will only be developed for the latest major version.
86+
7187
## Supported Rust Versions
7288

7389
Our driver's minimum supported Rust version (MSRV) is 1.70.0.

0 commit comments

Comments
 (0)