Skip to content

Cleanup for pull requests and versioning policy. #49

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

Merged
merged 6 commits into from
Aug 24, 2018
Merged

Cleanup for pull requests and versioning policy. #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fa6f394
Add pull request template.
lizroth Aug 21, 2018
97a6f8a
Clarifications to versioning policy.
lizroth Aug 23, 2018
e627724
Fixes to RST lists in VERSIONING.
lizroth Aug 23, 2018
366bd1b
Small language consistency tweaks to VERSIONING.
lizroth Aug 23, 2018
874b281
Update VERSIONING.rst
juneb Aug 23, 2018
363a881
Additional minor tweaks/cleanup to VERSIONING.rst.
lizroth Aug 23, 2018
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
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*Issue #, if available:*

*Description of changes:*


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
28 changes: 20 additions & 8 deletions VERSIONING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,30 @@
Versioning Policy
*****************

We will use a three-part X.Y.Z (Major.Minor.Patch) versioning definition with the following meanings.
We use a three-part X.Y.Z (Major.Minor.Patch) versioning definition, as follows:

* X (Major) version changes cover changes to the code-base that are expected to break backwards compatibility.
* 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.
* Z (Patch) version changes cover small changes. They will not break backwards compatibility.
* **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 definitely recommend always running on the most recent version of our code. This is how we recommend doing so.
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.

* X changes will likely require dedicated time and work to incorporate into your code-base.
* 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.
* 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.)
* Good unit and integration tests are always recommended.