-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added breaking change definition #630
Open
mcastany
wants to merge
5
commits into
main
Choose a base branch
from
breaking-changes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,44 @@ | ||||||
--- | ||||||
title: Breaking Changes Policy | ||||||
sidebar_label: Breaking Changes | ||||||
slug: breaking-changes | ||||||
excerpt: Learn about breaking changes in RevenueCat | ||||||
--- | ||||||
|
||||||
At RevenueCat, we strive to provide a stable and reliable platform for developers integrating in-app subscriptions. To ensure smooth integrations while maintaining the flexibility to improve our platform, we have clear guidelines on what constitutes a breaking change and what does not. | ||||||
|
||||||
## Semantic Versioning (SemVer) | ||||||
|
||||||
We follow [Semantic Versioning (SemVer)](https://semver.org/) for our SDKs to ensure predictable and transparent versioning. This means: | ||||||
|
||||||
- Major versions (X.0.0) may introduce breaking changes. | ||||||
- Minor versions (X.Y.0) introduce backwards-compatible new features. | ||||||
- Patch versions (X.Y.Z) contain backwards-compatible bug fixes and improvements. | ||||||
|
||||||
## What is a backwards compatible change? | ||||||
|
||||||
The following types of changes are not considered breaking: | ||||||
|
||||||
1. Additive API changes, such as: | ||||||
1. Adding new optional fields to API responses. | ||||||
2. Introducing new endpoints without modifying existing ones. | ||||||
3. Expanding webhook event payloads with additional fields. | ||||||
2. Introducing new SDK methods that do not affect existing ones. | ||||||
3. Bug fixes and performance improvements that do not alter documented behaviors. | ||||||
4. Changes to internal logic that do not affect the API contract or documented SDK behavior. | ||||||
5. Deprecating features with proper notice while keeping existing functionality intact during a transition period. | ||||||
6. Updating documentation to clarify existing behaviors without modifying the implementation. | ||||||
|
||||||
## Deprecation and Migration Policy | ||||||
|
||||||
When a breaking change is necessary, we follow these best practices: | ||||||
|
||||||
- Deprecation Notices: We provide advance notice through our changelogs, documentation, and direct customer communications. | ||||||
- Grace Periods: Wherever possible, we maintain backward compatibility and provide transition periods for developers to update their integrations. | ||||||
- 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. | ||||||
|
||||||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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"?