-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3551f33
commit 4849d7f
Showing
3 changed files
with
44 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
2.0.0-beta.2 | ||
2.0.0-beta.3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Versioning Strategy | ||
|
||
`telnyx-node` uses a modified version of [Semantic Versioning][semver] for | ||
all changes to the helper library. It is strongly encouraged that you pin at | ||
least the major version and potentially the minor version to avoid pulling in | ||
breaking changes. | ||
|
||
Semantic Versions take the form of `MAJOR.MINOR.PATCH` | ||
|
||
When bugs are fixed in the library in a backwards-compatible way, the `PATCH` | ||
level will be incremented by one. When new features are added to the library | ||
in a backwards-compatible way, the `PATCH` level will be incremented by one. | ||
`PATCH` changes should _not_ break your code and are generally safe for upgrade. | ||
|
||
When a new large feature set comes online or a small breaking change is | ||
introduced, the `MINOR` version will be incremented by one and the `PATCH` | ||
version reset to zero. `MINOR` changes _may_ require some amount of manual code | ||
change for upgrade. These backwards-incompatible changes will generally be | ||
limited to a small number of function signature changes. | ||
|
||
The `MAJOR` version is used to indicate the family of technology represented by | ||
the helper library. Breaking changes that require extensive reworking of code | ||
will cause the `MAJOR` version to be incremented by one, and the `MINOR` and | ||
`PATCH` versions will be reset to zero. Telnyx understands that this can be very | ||
disruptive, so we will only introduce this type of breaking change when | ||
absolutely necessary. New `MAJOR` versions will be communicated in advance with | ||
`Release Candidates` and a schedule. | ||
|
||
## Supported Versions | ||
|
||
Only the current `MAJOR` version of `telnyx-node` is supported. New | ||
features, functionality, bug fixes, and security updates will only be added to | ||
the current `MAJOR` version. | ||
|
||
[semver]: https://semver.org |