Skip to content

Add versioning policy for v2.0.0+ #105

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 24, 2025
Merged

Add versioning policy for v2.0.0+ #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@ Fork from https://github.com/jarredholman/ruby-zstd.
## Zstd version
[v1.5.7](https://github.com/facebook/zstd/tree/v1.5.7)

## Versioning Policy

Starting from v2.0.0, this gem follows Semantic Versioning.

- **Major version** (X.0.0): Breaking changes to the API
- **Minor version** (X.Y.0): New features, including Zstd library version updates
- **Patch version** (X.Y.Z): Bug fixes and other backward-compatible changes

### Zstd Library Updates

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.

**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.

## Installation

Add this line to your application's Gemfile:
Expand Down