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

Add version guarantees page #34

Merged
merged 1 commit into from Feb 17, 2023
Merged

Add version guarantees page #34

merged 1 commit into from Feb 17, 2023

Conversation

ItsDrike
Copy link
Member

Add a page explaining what guarantees our versioning scheme provides: what changes can and can't be made between minor versions.

This partially helps define our public API, as it clearly states that typing features will NOT be treated as breaking changes, and therefore typing can change between minor versions. It's should exactly be considered as something internal, but changes without deprecations can be made.

This PR is a part of #19.

@ItsDrike ItsDrike added a: documentation Related to project's documentation (comments, docstrings, docs) p: 2 - normal Normal priority t: feature New request or feature labels Feb 16, 2023
@ItsDrike ItsDrike merged commit 5e14f75 into main Feb 17, 2023
@ItsDrike ItsDrike deleted the add-version-guarantees-page branch February 17, 2023 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: documentation Related to project's documentation (comments, docstrings, docs) p: 2 - normal Normal priority t: feature New request or feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant