Skip to content

Commit

Permalink
Make addressing deprecations acceptable in a patch release
Browse files Browse the repository at this point in the history
Addressing a deprecation is not a bugfix, it does not make the software
more stable. Deprecations are annoying though, and unless we switch to
using the ~ operator instead of the ^ operator for our dependencies, we
might get new ones out of the blue.
I propose to explicitly allow PRs that address deprecations in patch
releases, so that users do not have to wait until the next minor to have
fewer deprecations.
  • Loading branch information
greg0ire committed Jun 1, 2023
1 parent 51c75ce commit 27a8ff5
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions source/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ With that in mind, things that can go on the patch release branch
include:

- bugfixes;
- addressing deprecations from dependencies;
- adding tests, especially for bugs that were fixed;
- updates, corrections or improvements to non-code assets like
documentation, build scripts or tooling configuration;
Expand All @@ -125,6 +126,12 @@ include:
When phpdoc comments are imprecise but not wrong technically, target
the next minor release branch instead.

.. note::
When addressing a deprecation notice from a dependency, make sure not
to bump any version constraint, so as to keep the patch release
obtainable without upgrading any other dependencies. You may use
feature detection (calls to ``class_exists()`` and such)to do so.

The next minor version branch may include:

- refactorings, unless they are necessary for a bugfix. This is to avoid
Expand Down

0 comments on commit 27a8ff5

Please sign in to comment.