Added breaking change definition #630
Open
Conversation
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
|
Preview this PR here: https://dev-docs.revenuecat.com/pr-630/ |
mcastany
changed the title
mshmoustafa
reviewed
Feb 3, 2025
| - Versioning: Breaking changes may be introduced in new major versions of our SDKs or API versions, ensuring that existing implementations continue to function as expected. | ||
| - Migration Guides: We provide clear upgrade paths and documentation to help developers adapt to changes. | ||
|
|
||
| Our goal is to minimize disruptions while ensuring RevenueCat continues to evolve and improve. If you have any concerns about a potential breaking change, please reach out via our support channels or check our changelog for the latest updates. |
There was a problem hiding this comment.
Suggested change
| Our goal is to minimize disruptions while ensuring RevenueCat continues to evolve and improve. If you have any concerns about a potential breaking change, please reach out via our support channels or check our changelog for the latest updates. | |
| Our goal is to minimize disruptions while ensuring RevenueCat continues to evolve and improve. If you have any concerns about a potential breaking change, please reach out via [our support channels](https://app.revenuecat.com/settings/support) or check our changelog for the latest updates. |
There was a problem hiding this comment.
Also I got into hot water when I mentioned the changelog to Outlier and he said "what changelog" and I didn't have a great answer for him. We have release notes but it doesn't include all API changes, neither does the community or email newsletter. Should we just remove "check our changelog"?
|
|
||
| Our goal is to minimize disruptions while ensuring RevenueCat continues to evolve and improve. If you have any concerns about a potential breaking change, please reach out via our support channels or check our changelog for the latest updates. | ||
|
|
||
| For further clarification or to discuss how a change might impact your integration, feel free to contact us! |
There was a problem hiding this comment.
Suggested change
| For further clarification or to discuss how a change might impact your integration, feel free to contact us! | |
| For further clarification or to discuss how a change might impact your integration, feel free to [contact us](https://app.revenuecat.com/settings/support)! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation / Description
A customer complained about us adding a new property to our API and their app breaking. This should protect us in case of future cases
Changes introduced
Add our definition of a backwards compatible change
Linear ticket (if any)
Additional comments