ably / engineering

Ably's new home for engineering guidance, including content previously served from Confluence at engineering.ably.com.
https://engineering.ably.com/
Apache License 2.0
2 stars 6 forks source link

Define 'breaking change' for Ably SDKs #46

Open QuintinWillison opened 1 year ago

QuintinWillison commented 1 year ago

In #45 we're starting to flesh out what a 'version bump' means for an Ably SDK, including what should trigger different grades of bump (major vs minor, etc..).

There are scenarios where we may need to present a 'breaking change' where there is no change to user-facing SDK APIs. We should produce some guidance around what Ably considers a breaking SDK change in relation to less obvious edge cases (e.g. dropping support for a platform/runtime version).

As pointed out and illustrated in more detail by @owenpearson in this comment,

ably-sync-bot commented 1 year ago

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-2942