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

Update release docs with a section for versioning strategy #3629

Merged
merged 1 commit into from
Oct 21, 2024
Merged
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# Versioning

Versioning of Cadence releases follows the below strategy:
- A language-breaking change (which is rare) would be a major version change.
- e.g: If the current version is `1.0.0` then the new version should be `v2.0.0`.
- Any other changes that are not bug fixes, (feature additions, Go API changes, etc.) would be a minor version change.
- e.g: If the current version is `1.0.0` then the new version should be `v1.1.0`.
- Bug fixes are patch versions.
- e.g: If the current version is `1.0.0` then the new version should be `v1.0.1`.

# Release Process

Assume releasing Cadence version `v0.21.2` from `master` branch.
Expand Down
Loading