|
2 | 2 | Versioning Policy
|
3 | 3 | *****************
|
4 | 4 |
|
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: |
6 | 6 |
|
7 | 7 | * **X (Major)** version changes are significant and expected to break backwards compatibility.
|
8 | 8 | * **Y (Minor)** version changes are moderate changes. These include:
|
9 | 9 |
|
10 | 10 | * 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. |
13 | 13 |
|
14 | 14 | * **Z (Patch)** version changes are small changes. These changes will not break backwards compatibility.
|
15 | 15 |
|
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. |
17 | 17 |
|
18 | 18 | What this means for you
|
19 | 19 | =======================
|
20 | 20 |
|
21 | 21 | We recommend running the most recent version. Here are our suggestions for managing updates:
|
22 | 22 |
|
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. |
25 | 25 |
|
26 | 26 | * If you have good unit and integration tests, these changes are generally safe to pick up automatically.
|
27 | 27 |
|
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. |
29 | 29 |
|
30 | 30 | * Good unit and integration tests are always recommended.
|
31 | 31 |
|
0 commit comments