Skip to content

Commit cc056aa

Browse files
committed
Make addressing deprecations acceptable in a patch release
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.
1 parent 51c75ce commit cc056aa

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

source/contribute.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ With that in mind, things that can go on the patch release branch
113113
include:
114114

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

129+
.. note::
130+
When addressing a deprecation notice from a dependency, make sure not
131+
to bump any version constraint, so as to keep the patch release
132+
obtainable without upgrading any other dependencies. You may use
133+
feature detection (calls to ``class_exists()`` and such) to do so.
134+
128135
The next minor version branch may include:
129136

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

0 commit comments

Comments
 (0)