Skip to content

Commit

Permalink
docs: Add deprecation period policy example for post-1.0.0 (#14184)
Browse files Browse the repository at this point in the history
Co-authored-by: Stijn de Gooijer <stijndegooijer@gmail.com>
  • Loading branch information
MarcoGorelli and stinodego authored Feb 6, 2024
1 parent 79ffe72 commit 6ab6550
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/development/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,10 @@ Such changes will not be warned for, but _will_ be included in the changelog and
### Deprecation period

As a rule, deprecated functionality is removed two breaking releases after the deprecation happens.
For example, a function deprecated in version `0.18.3` will be removed in version `0.20.0`.
For example:

- Before the release of `1.0.0`: a function deprecated in version `0.18.3` will be removed in version `0.20.0`
- After the release of `1.0.0`: a function deprecated in version `1.2.3` will be removed in version `3.0.0`

This means that if your program does not raise any deprecation warnings, it should be mostly safe to upgrade to the next breaking release.
As breaking releases happen about once every three months, this allows three to six months to adjust to any pending breaking changes.
Expand Down

0 comments on commit 6ab6550

Please sign in to comment.