JohnHammond
/
base64io-python
mirror of https://github.com/JohnHammond/base64io-python.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add VERSIONING.rst. (#20)

development
lizroth 2018-08-24 15:16:13 -07:00 committed by Matt Bullock
parent 95c7b07693
commit 53de2b6cb6
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
VERSIONING.rst Normal file
View File

@ -0,0 +1,31 @@
*****************
Versioning Policy
*****************
We use a three-part X.Y.Z (Major.Minor.Patch) versioning definition, as follows:
* **X (Major)** version changes are significant and expected to break backwards compatibility.
* **Y (Minor)** version changes are moderate changes. These include:
* Significant non-breaking feature additions.
* Any change to the version of a dependency.
* Possible backwards-incompatible changes. These changes will be noted and explained in detail in the release notes.
* **Z (Patch)** version changes are small changes. These changes will not break backwards compatibility.
* Z releases will also include warning of upcoming breaking changes, whenever possible.
What this means for you
=======================
We recommend running the most recent version. Here are our suggestions for managing updates:
* X changes will require some effort to incorporate.
* Y changes will not require significant effort to incorporate.
* If you have good unit and integration tests, these changes are generally safe to pick up automatically.
* Z changes will not require any changes to your code. Z changes are intended to be picked up automatically.
* Good unit and integration tests are always recommended.