Skip to content

Commit 1667c0e

Browse files
SalusaSecondusmattsb42-aws
authored andcommitted
Statement of our versioning policy and philosophy (#46)
* Statement of our versioning policy and philosophy * Update VERSIONING.rst
1 parent 0808019 commit 1667c0e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

VERSIONING.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
*****************
2+
Versioning Policy
3+
*****************
4+
5+
We will use a three-part X.Y.Z (Major.Minor.Patch) versioning definition with the following meanings.
6+
7+
* X (Major) version changes cover changes to the code-base that are expected to break backwards compatibility.
8+
* Y (Minor) version changes cover moderate changes. These include significant (non-breaking) feature additions and might contain changes which break backwards compatability. If there are breaking changes, they will be explicitly stated in the release notes.
9+
* Z (Patch) version changes cover small changes. They will not break backwards compatibility.
10+
11+
What this means for you
12+
=======================
13+
14+
We definitely recommend always running on the most recent version of our code. This is how we recommend doing so.
15+
16+
* X changes will likely require dedicated time and work to incorporate into your code-base.
17+
* Y changes are unlikely to require significant (or any) work to incorporate. If you have good unit and integration tests, they can likely be picked up in an automated manner.
18+
* Z changes should not require any changes to your code and can be picked up in an automated manner. (Good unit and integration tests are always recommended.)
19+

0 commit comments

Comments
 (0)