Skip to content

Commit

Permalink
add Versions info
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasassisrosa committed Oct 14, 2024
1 parent 3551f33 commit 4849d7f
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 4 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ applications written in server-side JavaScript.

See the [Node API docs](https://developers.telnyx.com/docs/api/v2/overview?lang=node#getting-started).

## Versions

`telnyx-node` uses a slightly modified version of [Semantic Versioning](https://semver.org) for all changes. [See this document](VERSIONS.md) for details.

## Installation

Install the package with:
Expand Down Expand Up @@ -43,9 +47,10 @@ callback:

```typescript
// Create a new messaging profile and then send a message using that profile:
telnyx.messagingProfiles.create({
name: 'Summer Campaign',
})
telnyx.messagingProfiles
.create({
name: 'Summer Campaign',
})
.then((messagingProfile) => {
return telnyx.messagingPhoneNumbers.update('+18005554000', {
messaging_profile_id: messagingProfile.data.id,
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.0.0-beta.2
2.0.0-beta.3
35 changes: 35 additions & 0 deletions VERSIONS.md
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

0 comments on commit 4849d7f

Please sign in to comment.