Skip to content

Commit 169185c

Browse files
committed
Add versioning policy for v2.0.0+
- Add Semantic Versioning policy starting from v2.0.0 - Clarify that Zstd library updates will be minor releases - Explain the transition from previous versioning scheme Resolves #86
1 parent 921ea17 commit 169185c

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,20 @@ Fork from https://github.com/jarredholman/ruby-zstd.
1212
## Zstd version
1313
[v1.5.7](https://github.com/facebook/zstd/tree/v1.5.7)
1414

15+
## Versioning Policy
16+
17+
Starting from v2.0.0, this gem follows Semantic Versioning.
18+
19+
- **Major version** (X.0.0): Breaking changes to the API
20+
- **Minor version** (X.Y.0): New features, including Zstd library version updates
21+
- **Patch version** (X.Y.Z): Bug fixes and other backward-compatible changes
22+
23+
### Zstd Library Updates
24+
25+
Updates to the underlying Zstd library version will be released as **minor version** updates, as they may introduce new features or performance improvements while maintaining backward compatibility.
26+
27+
**Note**: Versions prior to v2.0.0 followed the Zstd library versioning scheme with an additional patch number (e.g., 1.5.6.2). This approach has been replaced with semantic versioning to provide clearer expectations for API stability.
28+
1529
## Installation
1630

1731
Add this line to your application's Gemfile:

0 commit comments

Comments
 (0)