Skip to content

Commit 8f8b9dc

Browse files
authored
docs(versioning): add versioning policy (#231)
1 parent 297d00d commit 8f8b9dc

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

VERSIONING.rst

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
*****************
2+
Versioning Policy
3+
*****************
4+
5+
We use a three-part X.Y.Z (Major.Minor.Patch) versioning definition, as follows:
6+
7+
* **X (Major)** version changes are significant and expected to break backwards compatibility.
8+
* **Y (Minor)** version changes are moderate changes. These include:
9+
10+
* Significant non-breaking feature additions.
11+
* Any change to the version of a dependency.
12+
* Possible backwards-incompatible changes. These changes will be noted and explained in detail in the release notes.
13+
14+
* **Z (Patch)** version changes are small changes. These changes will not break backwards compatibility.
15+
16+
* Z releases will also include warning of upcoming breaking changes, whenever possible.
17+
18+
What this means for you
19+
=======================
20+
21+
We recommend running the most recent version. Here are our suggestions for managing updates:
22+
23+
* X changes will require some effort to incorporate.
24+
* Y changes will not require significant effort to incorporate.
25+
26+
* If you have good unit and integration tests, these changes are generally safe to pick up automatically.
27+
28+
* Z changes will not require any changes to your code. Z changes are intended to be picked up automatically.
29+
30+
* Good unit and integration tests are always recommended.
31+

0 commit comments

Comments
 (0)