docs(dev): add compatibility policy (SemVer + deprecation + public-API) (#1952)#1978
Open
mvillmow wants to merge 2 commits into
Open
docs(dev): add compatibility policy (SemVer + deprecation + public-API) (#1952)#1978mvillmow wants to merge 2 commits into
mvillmow wants to merge 2 commits into
Conversation
…quired.yml (#1944) Partial fix for #1944 — converts the two security jobs (pip-audit and secrets-scan) from inline copies in _required.yml into a single workflow_call to security.yml. _required.yml now delegates via `uses: ./.github/workflows/security.yml` rather than copy-pasting 74 lines of job body. Branch-protection contexts "Dependency vulnerability scan" and "Secrets scan (gitleaks)" are unchanged — they are emitted by the jobs inside security.yml directly. No job IDs visible from outside are renamed. Remaining duplicated jobs (lint, unit-tests, integration-tests) are deferred to follow-up PRs using the same workflow_call pattern. Refs #1944 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
) Repo had no migration or backwards-compatibility policy documented. Adds docs/dev/compatibility.md with: - SemVer interpretation and breaking-change triggers - Deprecation window (one minor cycle of DeprecationWarning before removal) - Curated public-API surface (narrower than __init__.py __all__ which re-exports 9 sub-packages) CONTRIBUTING.md links to it from a new 'Versioning & Compatibility' subsection under the existing Versioning and Releases section. Notes that release notes are auto-generated via gh release create --generate-notes (CHANGELOG.md was removed in PR #1960). Closes #1952
mvillmow
force-pushed
the
1952-compatibility-policy
branch
from
f1c03f5 to
ddd7d3d
Compare
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.
Summary
Repo had no migration or backwards-compatibility policy. Adds
docs/dev/compatibility.md:DeprecationWarningbefore removal__init__.py.__all__which re-exports 9 whole sub-packages)CONTRIBUTING.mdgets a new 'Versioning & Compatibility' subsection linking to the policy.Closes #1952
🤖 Generated with Claude Code