Skip to content

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 10 commits into from
Sep 20, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updates
  • Loading branch information
TomAugspurger committed Sep 19, 2019
commit aa932cbf5db9c5927f65b0d7459adc71f9f71308
22 changes: 14 additions & 8 deletions doc/source/development/policies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,31 @@ Version Policy

.. versionchanged:: 1.0.0

Pandas uses a variant of `SemVer`_ to govern deprecations, API compatibility, and version numbering.
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.
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.
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
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.
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::

Expand Down