Skip to content

Commit 7c484d8

Browse files
committed
Added VERSIONING.md and updates CHANGELOG.md
1 parent cd96025 commit 7c484d8

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
## 2.4.0 ##
2+
**API breaking change: tech.ydb.topic.decription.Codec became interface**
23
* Core: Upgrade to grpc-java v1.68.3
34
* Core: Upgrade to use slf4j2
45
* Core: Removed thread lock on the waiting of channel ready

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ After that you can specify the SDK modules that your project needs in the depend
7373
</dependencies>
7474
```
7575

76+
## Versioning Policy
77+
78+
YDB Java SDK comply to guidelines from [SemVer2.0.0](https://semver.org/) with several [exceptions](VERSIONING.md).
79+
7680
## Examples ##
7781

7882
#### Using Maven ####

VERSIONING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# YDB Java SDK Versioning Policy
2+
3+
By adhering to these guidelines and exceptions, we aim to provide a stable and reliable development experience for our users (aka [LTS](https://en.wikipedia.org/wiki/Long-term_support)) while still allowing for innovation and improvement.
4+
5+
We endeavor to adhere to versioning guidelines as defined by [SemVer2.0.0](https://semver.org/).
6+
7+
We making the following exceptions to those guidelines:
8+
## Experimental
9+
- We use the `@Experimental` annotation for new features in the `ydb-java-sdk`.
10+
- Early adopters of newest feature can report bugs and imperfections in functionality.
11+
- For fix this issues we can make broken changes in experimental API.
12+
- We reserve the right to remove or modify these experimental features at any time without increase of major part of version.
13+
- We want to make experimental API as stable in the future
14+
## Deprecated
15+
- We use the `@Deprecated` annotation for deprecated features in the `ydb-java-sdk`.
16+
- This helps to our users to soft decline to use the deprecated feature without any impact on their code.
17+
- Deprecated features will not be removed or changed for a minimum period of **six months** since the mark added.
18+
- We reserve the right to remove or modify these deprecated features without increase of major part of version.
19+
## Internals
20+
- Some public API of `ydb-java-sdk` relate to the internals.
21+
- Internal classes are located in packages `impl` or `utils`.
22+
- `ydb-java-sdk` internals can be changed at any time without increase of major part of version.
23+
- Internals will never marked as stable

0 commit comments

Comments
 (0)