Skip to content

Commit

Permalink
Create VERSIONING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jenschude authored Nov 22, 2021
1 parent b73b974 commit de8c25f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions VERSIONING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Versioning

The SDK is following [Semantic Versioning 2.0](https://semver.org/spec/v2.0.0.html)

## Scope

As the SDK is in great parts generated from an API specification, the release notes
may not reflect all changes in detail.

In case of breaking changes they are written out separately in the release notes.

A fix (e.g. wrong return type made a property not usable) which would result in
a compile time breaking change will be treated as MINOR or PATCH version change.

Other type changes (e.g. splitting a model to reflect differences between Read & Write models)
are treated as breaking change.

0 comments on commit de8c25f

Please sign in to comment.