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.

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

README: document versioning scheme #142

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

README: document versioning scheme #142

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
362b804
README: document versioning scheme
krzema12 Mar 20, 2024
9936273
Update README.md
krzema12 Mar 20, 2024
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,21 @@ dependencies {

To learn about the API, it's best to start with snakeyaml-engine's (upstream project's) docs [here](https://bitbucket.org/snakeyaml/snakeyaml-engine/wiki/Documentation).

# Versioning

Semantic versioning is not strictly followed here because we try to reflect the upstream project's versioning.

The major and minor version number correspond to the major and minor version number of the upstream project
([SnakeYAML Engine](https://bitbucket.org/snakeyaml/snakeyaml-engine/)). Bumping the patch version can happen
in two cases:
* the upstream project released a new version with the patch version number increased,
* some adjustment strictly related to this port library was needed, while being in sync with the same
major and minor version number of the upstream project. In particular, it may happen that there's a breaking
change not related to reflecting a newer version of the upstream project, then just the patch version number
will be incremented.

The release notes for each version mentions which version of the upstream project the given release corresponds to.

### Snapshot releases

Snapshot versions of SnakeYAML Engine KMP (straight from the main branch) are available.
Expand Down
Loading