Skip to content
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

docs: add guidelines for breaking changes #2402

Merged
merged 5 commits into from
Jun 2, 2023

Conversation

aucampia
Copy link
Member

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

  • Checked that there aren't other open pull requests for
    the same change.
  • Checked that all tests and type checking passes.
  • Considered granting push permissions to the PR branch,
    so maintainers can fix minor issues and keep your PR up to date.

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
@aucampia aucampia requested a review from a team May 22, 2023 20:15
@aucampia aucampia added the review wanted This indicates that the PR is ready for review label May 22, 2023
@coveralls
Copy link

coveralls commented May 22, 2023

Coverage Status

coverage: 90.851%. remained the same when pulling f706279 on aucampia:aucampia/20230522T2045-devnote into 7860cd4 on RDFLib:main.

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]>
@aucampia aucampia merged commit cad367e into RDFLib:main Jun 2, 2023
@aucampia aucampia deleted the aucampia/20230522T2045-devnote branch June 8, 2023 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review wanted This indicates that the PR is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants