From c90430954bc1d8fa947bc2734b275783391e3099 Mon Sep 17 00:00:00 2001 From: Ekaterina Gerasimova Date: Thu, 29 Jul 2021 16:17:04 +0100 Subject: [PATCH 1/5] Update issue labelling guidelines in README Add "prevalence" labels to use as a guideline for how often issues crop up. Combine prevalence and severity to indicate correspondence to how defects should be prioritised by the team. --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8bf6ecd8cf..22166b66bf 100644 --- a/README.md +++ b/README.md @@ -415,19 +415,24 @@ We strive to completely cover all applicable issues with these core labels: * __[S-Tolerable](https://github.com/vector-im/element-web/labels/S-Tolerable):__ Purely cosmetic or low / no impact to users -3. __Priority__ — All issues which are not `T-Other` are assigned a priority: - * __[P1](https://github.com/vector-im/element-web/labels/P1):__ Next - * __[P2](https://github.com/vector-im/element-web/labels/P2):__ Later - * __[P3](https://github.com/vector-im/element-web/labels/P3):__ Eventually - * __[P4](https://github.com/vector-im/element-web/labels/P4):__ Interesting — - Not yet scheduled, will accept patches - * __[P5](https://github.com/vector-im/element-web/labels/P5):__ Dubious — - Will not schedule, would consider patches +3. __Prevalence__ — All issues labeled `T-Defect` are also assigned a prevalence: + * __[P-High](https://github.com/vector-im/element-web/labels/P-High):__ Affects most users regularly or impacts most users' first experience (e.g. registration) + * __[P-Medium](https://github.com/vector-im/element-web/labels/P-Medium):__ Affects some users regularly or most users rarely + * __[P-Low](https://github.com/vector-im/element-web/labels/P-Low):__ Most users are unlikely to come across this or it is a corner case 4. __Area__ — Most issues are assigned one or several "areas" using one of the many `A-` prefixed labels, e.g. `A-Composer` or `A-Spaces`. Each area label maps to a group of features or portion of the UI surface in the app. +The Priority label is now deprecated. Defects will now be classed based on their severity and frequency +| Labels | Equivalent priority | What it means | +| ----------- | ----------- | ----------- | +| S‑Critical and F‑High
S‑Critical and F‑Medium
S‑Major and F‑High | P1 | These issues should be worked on in this sprint or next sprint. If the backlog of issues is too long, we should reevaluate why the bugs are not caught earlier. | +| S‑Critical and F‑Low
S‑Major and F‑Medium
S‑Minor and F‑High | P2 | When all the highest priority bugs are done, this is the next set to tackle. Ideally we should be fixing a few issues from this group every week. | +| S‑Major and F‑Low
S‑Minor and F‑Medium
S‑Tolerable and F‑High | P3 | These issues are wishful thinking. We hope to get to them one day, but we they are low priority. There are likely to be some good new contributor issues in here. | +| S‑Minor and F‑Low
S‑Tolerable and F‑Medium
S‑Minor and F‑Low | P4 and P5 | These issues are unlikely to be actively looked at by the webapp team, but may be picked up by community. | + + ### Other common labels We have a handful of other labels which are added on an as-needed basis, and not expected to be exhaustive: From d6606afd7247c273a0415ddf5e4a612d809eef07 Mon Sep 17 00:00:00 2001 From: Kat Gerasimova Date: Tue, 3 Aug 2021 13:35:31 +0100 Subject: [PATCH 2/5] Improve wording for triage label usage in README Signed-off-by: Ekaterina Gerasimova --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 22166b66bf..9b877c22fa 100644 --- a/README.md +++ b/README.md @@ -419,12 +419,13 @@ We strive to completely cover all applicable issues with these core labels: * __[P-High](https://github.com/vector-im/element-web/labels/P-High):__ Affects most users regularly or impacts most users' first experience (e.g. registration) * __[P-Medium](https://github.com/vector-im/element-web/labels/P-Medium):__ Affects some users regularly or most users rarely * __[P-Low](https://github.com/vector-im/element-web/labels/P-Low):__ Most users are unlikely to come across this or it is a corner case + This label may also be used for other types of issue. 4. __Area__ — Most issues are assigned one or several "areas" using one of the many `A-` prefixed labels, e.g. `A-Composer` or `A-Spaces`. Each area label maps to a group of features or portion of the UI surface in the app. -The Priority label is now deprecated. Defects will now be classed based on their severity and frequency +The Priority label is now deprecated. Defects will now be classed based on their severity and prevalence: | Labels | Equivalent priority | What it means | | ----------- | ----------- | ----------- | | S‑Critical and F‑High
S‑Critical and F‑Medium
S‑Major and F‑High | P1 | These issues should be worked on in this sprint or next sprint. If the backlog of issues is too long, we should reevaluate why the bugs are not caught earlier. | From 99c9824e15df9e0628185d9b75f1a1602816d337 Mon Sep 17 00:00:00 2001 From: Kat Gerasimova Date: Tue, 3 Aug 2021 14:08:02 +0100 Subject: [PATCH 3/5] Fix typo in triage text in the README Signed-off-by: Ekaterina Gerasimova --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9b877c22fa..b97bdef63a 100644 --- a/README.md +++ b/README.md @@ -428,10 +428,10 @@ We strive to completely cover all applicable issues with these core labels: The Priority label is now deprecated. Defects will now be classed based on their severity and prevalence: | Labels | Equivalent priority | What it means | | ----------- | ----------- | ----------- | -| S‑Critical and F‑High
S‑Critical and F‑Medium
S‑Major and F‑High | P1 | These issues should be worked on in this sprint or next sprint. If the backlog of issues is too long, we should reevaluate why the bugs are not caught earlier. | -| S‑Critical and F‑Low
S‑Major and F‑Medium
S‑Minor and F‑High | P2 | When all the highest priority bugs are done, this is the next set to tackle. Ideally we should be fixing a few issues from this group every week. | -| S‑Major and F‑Low
S‑Minor and F‑Medium
S‑Tolerable and F‑High | P3 | These issues are wishful thinking. We hope to get to them one day, but we they are low priority. There are likely to be some good new contributor issues in here. | -| S‑Minor and F‑Low
S‑Tolerable and F‑Medium
S‑Minor and F‑Low | P4 and P5 | These issues are unlikely to be actively looked at by the webapp team, but may be picked up by community. | +| S‑Critical and P‑High
S‑Critical and P‑Medium
S‑Major and P‑High | P1 | These issues should be worked on in this sprint or next sprint. If the backlog of issues is too long, we should reevaluate why the bugs are not caught earlier. | +| S‑Critical and P‑Low
S‑Major and P‑Medium
S‑Minor and P‑High | P2 | When all the highest priority bugs are done, this is the next set to tackle. Ideally we should be fixing a few issues from this group every week. | +| S‑Major and P‑Low
S‑Minor and P‑Medium
S‑Tolerable and P‑High | P3 | These issues are wishful thinking. We hope to get to them one day, but we they are low priority. There are likely to be some good new contributor issues in here. | +| S‑Minor and P‑Low
S‑Tolerable and P‑Medium
S‑Minor and P‑Low | P4 and P5 | These issues are unlikely to be actively looked at by the webapp team, but may be picked up by community. | ### Other common labels From c29ef4bb5f1bf854d5df04b571047ead341716b0 Mon Sep 17 00:00:00 2001 From: Kat Gerasimova Date: Tue, 3 Aug 2021 15:09:53 +0100 Subject: [PATCH 4/5] Add empty line to improve rendering in README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Šimon Brandner --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b97bdef63a..7f7b81c370 100644 --- a/README.md +++ b/README.md @@ -419,7 +419,8 @@ We strive to completely cover all applicable issues with these core labels: * __[P-High](https://github.com/vector-im/element-web/labels/P-High):__ Affects most users regularly or impacts most users' first experience (e.g. registration) * __[P-Medium](https://github.com/vector-im/element-web/labels/P-Medium):__ Affects some users regularly or most users rarely * __[P-Low](https://github.com/vector-im/element-web/labels/P-Low):__ Most users are unlikely to come across this or it is a corner case - This label may also be used for other types of issue. + + This label may also be used for other types of issues. 4. __Area__ — Most issues are assigned one or several "areas" using one of the many `A-` prefixed labels, e.g. `A-Composer` or `A-Spaces`. Each area label From 2d6a8d3d1e972f5a624544498b3b027a7d58c921 Mon Sep 17 00:00:00 2001 From: Kat Gerasimova Date: Wed, 4 Aug 2021 10:19:53 +0100 Subject: [PATCH 5/5] Make triage wording in README friendlier Co-authored-by: James Salter --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f7b81c370..28e4a97a66 100644 --- a/README.md +++ b/README.md @@ -431,7 +431,7 @@ The Priority label is now deprecated. Defects will now be classed based on their | ----------- | ----------- | ----------- | | S‑Critical and P‑High
S‑Critical and P‑Medium
S‑Major and P‑High | P1 | These issues should be worked on in this sprint or next sprint. If the backlog of issues is too long, we should reevaluate why the bugs are not caught earlier. | | S‑Critical and P‑Low
S‑Major and P‑Medium
S‑Minor and P‑High | P2 | When all the highest priority bugs are done, this is the next set to tackle. Ideally we should be fixing a few issues from this group every week. | -| S‑Major and P‑Low
S‑Minor and P‑Medium
S‑Tolerable and P‑High | P3 | These issues are wishful thinking. We hope to get to them one day, but we they are low priority. There are likely to be some good new contributor issues in here. | +| S‑Major and P‑Low
S‑Minor and P‑Medium
S‑Tolerable and P‑High | P3 | These issues are wishful thinking for now. We hope to get to them one day, but they are low priority. There are likely to be some good new contributor issues in here. | | S‑Minor and P‑Low
S‑Tolerable and P‑Medium
S‑Minor and P‑Low | P4 and P5 | These issues are unlikely to be actively looked at by the webapp team, but may be picked up by community. |