From 372a338fc9f400b6ae5e38ed071bdc0aeea3fef0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Thu, 1 Jun 2023 11:01:19 +0200 Subject: [PATCH 1/2] 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. --- source/contribute.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/source/contribute.rst b/source/contribute.rst index 45a77484..bb6ac51b 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -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; @@ -125,6 +126,13 @@ 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 From 626b23516db2ccca6473fb6618fc8926e0d57865 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Thu, 1 Jun 2023 23:22:37 +0200 Subject: [PATCH 2/2] Document when bumping deps is allowed --- source/contribute.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/contribute.rst b/source/contribute.rst index bb6ac51b..9cee6fb0 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -120,6 +120,8 @@ include: - fixes to incorrect phpdoc comments (docblock type declarations, etc.); - updates, corrections or improvements to code comments that are not phpdoc comments; +- _development_ dependency bumps (regular dependencies should not be + bumped). .. note:: @@ -137,6 +139,7 @@ The next minor version branch may include: - refactorings, unless they are necessary for a bugfix. This is to avoid unnecessary risks. +- dependency bumps if they lead to code simplifications; - new deprecations - read our :ref:`Dedicated policy <./policies/deprecation>` to figure out how to contribute those.