docs: add guidelines for breaking changes #2402
Merged
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
Add guidelines on how breaking changes should be approached. The guidelines take a very pragmatic approach with known downsides, but this seems like the best compromise given the current situation. For prior discussion on this point see: - RDFLib#2395 - RDFLib#2108 - RDFLib#1841
This was referenced May 22, 2023
Closed
ajnelson-nist
added a commit
to casework/CASE-Utilities-Python
that referenced
this pull request
May 23, 2023
This sets `case-utils` and downstream Python tooling to take care in reviewing new RDFLib releases for breaking changes. RDFLib Issue 2402 and Discussion 2395 outline an upcoming development period for RDFLib that may see more frequent SEMVER-major version releases. References: * RDFLib/rdflib#2402 Signed-off-by: Alex Nelson <[email protected]>
mielvds
approved these changes
May 24, 2023
This was referenced Jul 6, 2023
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.
Summary of changes
Add guidelines on how breaking changes should be approached.
The guidelines take a very pragmatic approach with known downsides, but this seems like the best compromise given the current situation.
For prior discussion on this point, see:
Checklist
the same change.
so maintainers can fix minor issues and keep your PR up to date.