Skip to content

Commit 874b281

Browse files
authored
Update VERSIONING.rst
1 parent 366bd1b commit 874b281

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

VERSIONING.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,30 @@
22
Versioning Policy
33
*****************
44

5-
We use a three-part X.Y.Z (Major.Minor.Patch) versioning definition as follows:
5+
We use a three-part X.Y.Z (Major.Minor.Patch) versioning definition, as follows:
66

77
* **X (Major)** version changes are significant and expected to break backwards compatibility.
88
* **Y (Minor)** version changes are moderate changes. These include:
99

1010
* Significant non-breaking feature additions.
11-
* Potentially backwards incompatible changes. Any such changes will be explicitly stated in the release notes.
12-
* Changes to our package's declared dependency versions.
11+
* Any change to the version of a package dependency.
12+
* Possible backwards-incompatible changes. These changes will be noted and explained in detail in the release notes.
1313

1414
* **Z (Patch)** version changes are small changes. These changes will not break backwards compatibility.
1515

16-
* Where possible, we will advise of upcoming breaking changes with warnings in a Z release.
16+
* Z releases will also include warning of upcoming breaking changes, whenver possible.
1717

1818
What this means for you
1919
=======================
2020

2121
We recommend running the most recent version. Here are our suggestions for managing updates:
2222

23-
* Expect X changes to require effort to incorporate.
24-
* Expect Y changes not to require significant effort to incorporate.
23+
* X changes will require some effort to incorporate.
24+
* Y changes will not require significant effort to incorporate.
2525

2626
* If you have good unit and integration tests, these changes are generally safe to pick up automatically.
2727

28-
* Expect Z changes not to require changes to your code. Z changes are intended to be picked up automatically.
28+
* Z changes will not to require any changes to your code. Z changes are intended to be picked up automatically.
2929

3030
* Good unit and integration tests are always recommended.
3131

0 commit comments

Comments
 (0)