docs: add breaking changes policy document - #3147
Draft
fbaeuerle wants to merge 1 commit into
Draft
Conversation
Introduce breaking_changes.rst, documenting S-COREs policy for breaking changes.
github-project-automation
Bot
added this to
TLC - Technical Lead Circle and S-CORE Roadmap
|
The created documentation from the pull request is available at: docu-html |
4og
self-requested a review
August 3, 2026 08:57
fbaeuerle
commented
Aug 4, 2026
| There may be rare cases where a breaking change cannot be avoided, even if deprecation was considered. | ||
| In such cases: | ||
|
|
||
| * The commit introducing the breaking change **must** clearly state that it contains a breaking change, |
Contributor
Author
There was a problem hiding this comment.
Here I would suggest adding some sort of distinct tag to the git commit below the commit message like "BREAKING CHANGE", like described here
fbaeuerle
commented
Aug 4, 2026
| #. The functionality that the new addition is meant to replace is marked as deprecated (e.g. via | ||
| language-specific deprecation attributes/annotations, documentation notes, and/or compiler or linter | ||
| warnings), so that users are made aware of the planned removal as early as possible. | ||
| #. Users are given a **grace period** during which both the deprecated and the new functionality are |
Contributor
Author
There was a problem hiding this comment.
we have to specify the length of the grace period. for example for semver usually deprecated symbols are only removed on major releases.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Introduce breaking_changes.rst, documenting S-COREs policy for breaking changes.