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

Add documentation for version numbering and releases #809

Merged
merged 3 commits into from
Oct 31, 2024
Merged
Changes from 2 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
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,21 @@ An example project on how to upgrade from older tags can be found in the Integri

If you still experience issues during upgrading, do not hesitate to create an issue for support.

## Version numbers

Starting with release 1.16.0, we use a specific versioning schema in order to enable us to release the same version multiple times for different polkadot releases
- Major version numbers represent the version of the substrate-api-client
- Minor version numbers represent the polkadot release
- Note that this implies that there can be breaking changes in minor releases.
- Patch/bugfix number is still used for bugfixes

## Releases and backwards compatibility

- We usually create a release for each new polkadot release
- This release contains all the features of our current `master` branch
- We don't create releases for polkadot bugfix releases unless there are known issues
- We don't backport features and bugfixes per default. If requested we decide on a case by case basis.
- New releases can contain breaking changes. These are announced in the release notes.

## Alternatives

Expand Down