Skip to content

Commit 19ac73f

Browse files
committed
📝 docs: group maintenance backports by risk
1 parent 23c0153 commit 19ac73f

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

developer-workflow/development-cycle.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,15 @@ produced from a maintenance branch are called **bugfix** or **maintenance**
7474
releases; the terms are used interchangeably. These releases have a
7575
**micro version** number greater than zero.
7676

77-
The only changes allowed to occur in a maintenance branch without debate are
78-
bug fixes, test improvements, and edits to the documentation. Performance
79-
improvements are not among them: an optimization can introduce a regression,
80-
and a regression in a maintenance release is painful to track down and undo.
77+
Changes backported to a maintenance branch fall into two groups. *Low-risk*
78+
changes (bug fixes, test improvements, and documentation edits) may be
79+
backported without debate. *Higher-risk* changes (new features, semantic
80+
changes, and performance improvements) can introduce regressions, so they are
81+
not backported as a matter of course.
8182
Also, a general rule for maintenance branches is that compatibility
8283
must not be broken at any point between sibling micro releases (3.12.1, 3.12.2,
83-
etc.). For both rules, only rare exceptions are accepted and **must** be
84-
discussed first.
84+
etc.). For both rules, only rare exceptions are accepted, and each requires a
85+
strong case agreed upon in discussion beforehand.
8586

8687
Backporting changes reduces the risk of future conflicts.
8788
For documentation, it increases the visibility of improvements,

0 commit comments

Comments
 (0)