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

Jump to bottom

Add VERSIONING.md to sdk module #1296

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+15 −0
Open

Add VERSIONING.md to sdk module #1296

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c7f827
Add VERSIONING.md to sdk module
MrAlias Nov 18, 2024
1e14332
Merge branch 'main' into sdk-versioning
MrAlias Nov 18, 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 sdk/VERSIONING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Versioning

This document describes the versioning policy for this module.
This policy is designed so the following goals can be achieved.

**Users are provided a codebase of value that is stable and secure.**

## Policy

* Versioning of this module will be idiomatic of a Go project using [Go modules](https://github.com/golang/go/wiki/Modules).
* [Semantic import versioning](https://github.com/golang/go/wiki/Modules#semantic-import-versioning) will be used.
* Versions will comply with [semver 2.0](https://semver.org/spec/v2.0.0.html).
* Any `v2` or higher version of this module will be included as a `/vN` at the end of the module path used in `go.mod` files and in the package import path.

* GitHub releases will be made for all releases.
Loading