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.

Sign up for GitHub

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

docs(python): Update versioning docs for 1.0.0 #16757

Merged
merged 2 commits into from
Jun 6, 2024
Merged

docs(python): Update versioning docs for 1.0.0 #16757

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c93d06
docs(python): Update versioning docs for 1.0.0
stinodego Jun 6, 2024
c9da61b
Add reassuring phrase
stinodego Jun 6, 2024
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
5 changes: 3 additions & 2 deletions .github/release-drafter-python.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ version-resolver:
- breaking python
patch:
labels:
- fix
default: minor
- performance
- enhancement
default: patch

categories:
- title: 🏆 Highlights
Expand Down
20 changes: 18 additions & 2 deletions docs/development/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

## Version changes

Polars adheres to the [semantic versioning](https://semver.org/) specification.
Polars adheres to the [semantic versioning](https://semver.org/) specification:

As Polars has not released its `1.0.0` version yet, breaking releases lead to a minor version increase (e.g. from `0.18.15` to `0.19.0`), while all other releases increment the patch version (e.g. from `0.18.15` to `0.18.16`)
- Breaking changes lead to a **major** version increase (`1.0.0`, `2.0.0`, ...)
- New features and performance improvements lead to a **minor** version increase (`1.1.0`, `1.2.0`, ...)
- Other changes lead to a **patch** version increase (`1.0.1`, `1.0.2`, ...)

## Policy for breaking changes

Expand Down Expand Up @@ -92,3 +94,17 @@ As breaking releases happen about once every six months, this allows six to twel
**In some cases, we may decide to adjust the deprecation period.**
If retaining the deprecated functionality blocks other improvements to Polars, we may shorten the deprecation period to a single breaking release. This will be mentioned in the warning message.
If the deprecation affects many users, we may extend the deprecation period.

## Release frequency

Polars does not have a set release schedule.
We issue a new release whenever we feel like we have something new to offer that's valuable to our users.
In practice, a new minor version is released about once every one or two weeks.

### Breaking releases

Over time, issues pop up that require a breaking change to address.
When enough issues have accumulated, we issue a breaking release.

So far, breaking releases have happened about once every three to six months.
From this point on, we expect new major versions to be released about once every six months.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also add a sort of reassuring phrase that we expect the severity of the changes to reduce and be more on the periphery.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added in:

The rate and severity of breaking changes will continue to diminish as Polars grows more solid.