summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonas Karlsson <jonas.karlsson@qt.io>2024-10-31 11:10:14 +0100
committerVolker Hilsheimer <volker.hilsheimer@qt.io>2024-11-01 12:46:01 +0000
commitc8d2b806cc20936c4a74e86dad3b60fd69ae825d (patch)
tree2f71eb34373b62e66e003de80d29ea261ec1c705
parent554c546099cb8023eb081b2092d9a0d7cb247347 (diff)
[editorial] Clarify QUIP 16 cherry-pick table
Adds crosses for all the cells where a cherry-pick may be valid. I find this clearer when looking at the table compared to having to search to the right or left to see if that cell is implicitly crossed or not. Change-Id: Ice15d110967d80b3654705e8f7b3887681e38973 Reviewed-by: Tuukka Turunen <tuukka.turunen@qt.io> Reviewed-by: Marc Mutz <marc.mutz@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
-rw-r--r--quip-0016-branch-policy.rst57
1 files changed, 28 insertions, 29 deletions
diff --git a/quip-0016-branch-policy.rst b/quip-0016-branch-policy.rst
index 136d19e..b54ba7f 100644
--- a/quip-0016-branch-policy.rst
+++ b/quip-0016-branch-policy.rst
@@ -156,11 +156,10 @@ branch, any more recent stable branches, and dev.
Types of changes to cherry-pick
===============================
-The table below lists typical code changes, and indicates the branch the
-change may be cherry-picked to. The table shows the most stable branch (i.e.
-right-most), for every case. If a change is risky or it has lower impact,
-then it should only be cherry-picked to a less stable (i.e. further to the left)
-branch.
+The table below lists typical code changes, and indicates with a cross symbol
+the branches the change may be cherry-picked to. Generally, changes that are more
+risky or have lower impact should only be cherry-picked to a less stable (i.e.
+further to the left) branch.
Types of changes not listed here are in general only relevant for the dev branch,
and do not get cherry-picked. In particular, any feature addition, refactoring,
@@ -176,66 +175,66 @@ regressions.
| Reason for Change | Stable +--------+-------------+ Release | Notes |
| | | Strict | Very Strict | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Binary compatibility | | | | x | |
+| Binary compatibility | x | x | x | x | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Source compatibility | | | | x | |
+| Source compatibility | x | x | x | x | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| API review finding | | | | x | Initial release |
+| API review finding | x | x | x | x | Initial release |
| | | | | | only |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| RTA/package test finding | | | | x | |
+| RTA/package test finding | x | x | x | x | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Security issue | | | | x | |
+| Security issue | x | x | x | x | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| 3rd party update | | | x | | Very Strict only |
+| 3rd party update | x | x | x | | Very Strict only |
| | | | | | security/critical |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Adapt to minor OS/ | | | x | | |
+| Adapt to minor OS/ | x | x | x | | |
| Compiler updates | | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Memory leak | | x | | | |
+| Memory leak | x | x | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Feature added in this | | x | | | |
+| Feature added in this | x | x | | | |
| minor version | | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Undefined behavior | | x | | | |
+| Undefined behavior | x | x | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Something that makes | | x | | | |
+| Something that makes | x | x | | | |
| existing apps unstable | | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Performance: significant | | x | | | |
+| Performance: significant | x | x | | | |
| fix improving O() | | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Performance: Issue | x | | | | |
+| Performance: Issue | x | | | | |
| detected by profiling | | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Compiler warnings | | x | | | |
+| Compiler warnings | x | x | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| False positives | x | | | | e.g. static code |
+| False positives | x | | | | e.g. static code |
| raised by tools | | | | | analysers |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Documentation: small fixes | | | x | | |
+| Documentation: small fixes | x | x | x | | |
| (links, typos, warnings) | | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Documentation: refactoring | x | | | | |
+| Documentation: refactoring | x | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Tests: flakiness | | | x | | |
+| Tests: flakiness | x | x | x | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Tests: refactoring | x | | | | |
+| Tests: refactoring | x | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Bugs: Easily triggered | | | x | | |
+| Bugs: Easily triggered | x | x | x | | |
| crash | | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Bugs: Hard to reproduce | | x | | | |
+| Bugs: Hard to reproduce | x | x | | | |
| crash | | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Bugs: Regression | | x | | | |
+| Bugs: Regression | x | x | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Bugs: Hard-to-reproduce | x | | | | |
+| Bugs: Hard-to-reproduce | x | | | | |
| regression noticed some | | | | | |
| time after release | | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+
-| Bugs: Other | x | | | | |
+| Bugs: Other | x | | | | |
+----------------------------+--------+--------+-------------+---------+---------------------+