Skip to content

docs(versioning): add versioning policy #231

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.

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

Merged
merged 1 commit into from
Jun 6, 2023
Merged
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions VERSIONING.rst
Original file line number Diff line number Diff line change
@@ -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.