-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
Added version policy #28415
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
Merged
Merged
Added version policy #28415
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
dd57c71
Added version policy
TomAugspurger 0e9c33a
semver
TomAugspurger f346b43
note on experimental
TomAugspurger 9cd3236
Merge remote-tracking branch 'upstream/master' into version-policy
TomAugspurger 119fffc
updates
TomAugspurger 00a179b
Merge remote-tracking branch 'upstream/master' into version-policy
TomAugspurger 365801b
awkward
TomAugspurger 714dc3d
Merge remote-tracking branch 'upstream/master' into version-policy
TomAugspurger aa932cb
updates
TomAugspurger 1339330
fixup
TomAugspurger File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,4 +16,5 @@ Development | |
internals | ||
extending | ||
developer | ||
policies | ||
roadmap |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
.. _develop.policies: | ||
|
||
******** | ||
Policies | ||
******** | ||
|
||
.. _policies.version: | ||
|
||
Version Policy | ||
~~~~~~~~~~~~~~ | ||
|
||
.. versionchanged:: 1.0.0 | ||
|
||
Pandas uses a loose variant of semantic versioning (`SemVer`_) to govern | ||
deprecations, API compatibility, and version numbering. | ||
|
||
A pandas release number is made up of ``MAJOR.MINOR.PATCH``. | ||
|
||
API breaking changes should only occur in **major** releases. Theses changes | ||
will be documented, with clear guidance on what is changing, why it's changing, | ||
and how to migrate existing code to the new behavior. | ||
|
||
Whenever possible, a deprecation path will be provided rather than an outright | ||
breaking change. | ||
|
||
Pandas will introduce deprecations in **minor** releases. These deprecations | ||
will preserve the existing behavior while emitting a warning that provide | ||
guidance on: | ||
|
||
* How to achieve similar behavior if an alternative is available | ||
* The pandas version in which the deprecation will be enforced. | ||
|
||
We will not introduce new deprecations in patch releases. | ||
|
||
Deprecations will only be enforced in **major** releases. For example, if a | ||
behavior is deprecated in pandas 1.2.0, it will continue to work, with a | ||
warning, for all releases in the 1.x series. The behavior will change and the | ||
deprecation removed in the next next major release (2.0.0). | ||
|
||
.. note:: | ||
|
||
Pandas will sometimes make *behavior changing* bug fixes, as part of | ||
minor or patch releases. Whether or not a change is a bug fix or an | ||
API-breaking change is a judgement call. We'll do our best, and we | ||
invite you to participate in development discussion on the issue | ||
tracker or mailing list. | ||
|
||
These policies do not apply to features marked as **experimental** in the documentation. | ||
Pandas may change the behavior of experimental features at any time. | ||
|
||
Python Support | ||
~~~~~~~~~~~~~~ | ||
|
||
Pandas will only drop support for specific Python versions (e.g. 3.5.x, 3.6.x) in | ||
pandas **major** releases. | ||
|
||
.. _SemVer: https://semver.org |
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
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.
Uh oh!
There was an error while loading. Please reload this page.