forked from vega/altair
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Based on discussions in vega#3454 (comment) and vega#3454 (comment) vega#3454
- Loading branch information
1 parent
4cbc43d
commit 934517a
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,19 @@ | ||
Versioning | ||
========== | ||
Vega-Altair has historically released major versions that coincide with those of Vega-Lite_. | ||
|
||
As the projects have matured, and major versions become less frequent, there has been a growing need to introduce breaking changes between these major versions. | ||
Such changes would allow Vega-Altair to address technical debt and improve upon API ergonomics. | ||
|
||
To ensure future releases clearly communicate changes, Vega-Altair will be working towards adopting SemVer_. | ||
|
||
A Vega-Altair release number is composed of ``MAJOR.MINOR.PATCH``. | ||
|
||
* Backward incompatible API changes increment **MAJOR** version (`4.2.2` - `5.0.0`) | ||
* New backward compatible functionality increment **MINOR** version (`5.2.0` - `5.3.0`) | ||
* Backward compatible bug fixes increment **PATCH** version (`5.1.1` - `5.1.2`) | ||
|
||
**MAJOR** versions will *likely* continue to increase with a **MAJOR** increment to Vega-Lite_. | ||
|
||
.. _Vega-Lite: https://github.com/vega/vega-lite | ||
.. _SemVer: https://semver.org/ |