From cece5e4d2981ed62ac7f95cc523e2be63052023d Mon Sep 17 00:00:00 2001 From: Peter G Date: Thu, 19 May 2022 08:53:21 +0200 Subject: [PATCH 1/6] Create Bug_Coordinators.md --- Develop/Collaborate/Community/Bug_Coordinators.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 Develop/Collaborate/Community/Bug_Coordinators.md diff --git a/Develop/Collaborate/Community/Bug_Coordinators.md b/Develop/Collaborate/Community/Bug_Coordinators.md new file mode 100644 index 00000000..3299e27c --- /dev/null +++ b/Develop/Collaborate/Community/Bug_Coordinators.md @@ -0,0 +1 @@ +## Community Bug Coordination From a6143ef215fd4f8dbf59a02d4539e5691096f0ab Mon Sep 17 00:00:00 2001 From: Peter G Date: Thu, 19 May 2022 09:00:48 +0200 Subject: [PATCH 2/6] initial version --- .../Collaborate/Community/Bug_Coordinators.md | 85 +++++++++++++++++++ 1 file changed, 85 insertions(+) diff --git a/Develop/Collaborate/Community/Bug_Coordinators.md b/Develop/Collaborate/Community/Bug_Coordinators.md index 3299e27c..4cb53e92 100644 --- a/Develop/Collaborate/Community/Bug_Coordinators.md +++ b/Develop/Collaborate/Community/Bug_Coordinators.md @@ -1 +1,86 @@ ## Community Bug Coordination + +Starting with April 2022, members of the community support Jolla in coordinating Forum Bug Reports and internal bug tracking. + +### Project Goals + + - Improving transparency of internal bug handling + - Improved communication about new bug report + - Improved bug report quality + +### Lifecycle of a bug + + 1. A bug report is created by the user in the "Bug Reports" category + 2. Coordinators (and other forum members) work with the reporter to achieve "well-formed" status. + 3. Well-Formed bug reports are added to the Bug Coordination List + 4. About 10 Bug reports are picked to be presented in the Collaboration Meeting + - a couple of days before that, the list is submitted to the Collaboration Meeting coordination topic on the Forum + - Jolla creates internal Bug reports or updates existing ones + - Jolla tags the Bug Report posts as "tracked" + 7. After a Sailfish OS Release which contains the fix for the bug, the Bug Report post is tagged as "fixed" + 8. The original reporter may at any time mark the Bug Report post as "Solved" + 9. The original reporter should mark the Bug Report post as "Solved" + - after verifying a "fixed" bug is actually fixed for them + - another explanation (e.g. not a bug, by design, ...) has been given + - another solution (e.g. satisfying workaround) has been found + - the report has been identified as duplicate (se below) + + +#### Conditions for the report to be tagged as well-formed + * Bug report is written on the right category ("Bug Reports") + * Important information are given (Device and Version) + * Title is comprehensible + * Description is provided + * Expected result is provided + * Step-by-step instructions for reproducing the bug are provided + * The first post contains the most recent information (important bits are not hidden in later posts) + +### The Coordinator's List + +The team uses various tools and manual trawling of the forums to colloect (hopefully all) bug reports, and their well-formedness. + +#### Conditions for bugs to be forwarded to Jolla + +Until we have found a better heuristic, the 10 to-be-presented bugs are selected at random, with a slight bias towards new reports. + +### Tagging + +Depending the situation, Jolla will tag as tracked, pending or fixed. + +### Tools + +Once all these elements are checked, bug report will be tagged as Good and Jolla has only to sort bug reports to pick them and copy them to their internal bug tracker. Once this step is done, Jolla add the tracked tag. + +Tagged as good is currently defined as: the first post is liked by at least one of the bug-coordinators. + +After a new release and if a bug report is fixed, tag tracked is replaced with fixed. + +## Duplicates +If a bug report is reported twice (or more). It should ideally contains the main bug report as comment and set as solution. +After, topic should be closed. + +--- + + + +### Timeline + +2022-03-31: "Better tracking of bug report" question raised in the [Mar 31 Collaboration Meeting](https://irclogs.sailfishos.org/meetings/sailfishos-meeting/2022/sailfishos-meeting.2022-03-31-07.00.html), @pherung steps up as coordinator +2022-03-31: [Announcement](https://forum.sailfishos.org/t/new-role-community-bug-coordinator/10935) on the Forum +2022-04-05: (private) [Internal Discussions](https://forum.sailfishos.org/t/re-new-role-community-bug-coordinator/11032) by the new coordinator team on how to proceed +2022-04-xx: VArious tools created to support the process +2022-04-xx: Forum Bug Report Template improved +2022-nn-nn: Process documented on docs.sailfishos.org From c037aa87f545936360f67d8a42aaa3b48311cd39 Mon Sep 17 00:00:00 2001 From: Peter G Date: Thu, 19 May 2022 10:56:23 +0200 Subject: [PATCH 3/6] Update Bug_Coordinators.md --- .../Collaborate/Community/Bug_Coordinators.md | 42 ++++++++++++++----- 1 file changed, 31 insertions(+), 11 deletions(-) diff --git a/Develop/Collaborate/Community/Bug_Coordinators.md b/Develop/Collaborate/Community/Bug_Coordinators.md index 4cb53e92..7484bc55 100644 --- a/Develop/Collaborate/Community/Bug_Coordinators.md +++ b/Develop/Collaborate/Community/Bug_Coordinators.md @@ -1,11 +1,11 @@ ## Community Bug Coordination -Starting with April 2022, members of the community support Jolla in coordinating Forum Bug Reports and internal bug tracking. +Starting with April 2022, members of the community support Jolla with coordinating Forum Bug Reports and internal bug tracking. ### Project Goals - Improving transparency of internal bug handling - - Improved communication about new bug report + - Improved communication about new bug reports - Improved bug report quality ### Lifecycle of a bug @@ -23,7 +23,7 @@ Starting with April 2022, members of the community support Jolla in coordinating - after verifying a "fixed" bug is actually fixed for them - another explanation (e.g. not a bug, by design, ...) has been given - another solution (e.g. satisfying workaround) has been found - - the report has been identified as duplicate (se below) + - the report has been identified as duplicate (see below) #### Conditions for the report to be tagged as well-formed @@ -34,19 +34,37 @@ Starting with April 2022, members of the community support Jolla in coordinating * Expected result is provided * Step-by-step instructions for reproducing the bug are provided * The first post contains the most recent information (important bits are not hidden in later posts) - -### The Coordinator's List + +### Reponsibilities and Expectations + +#### CBC Team +##### The Coordinator's List The team uses various tools and manual trawling of the forums to colloect (hopefully all) bug reports, and their well-formedness. -#### Conditions for bugs to be forwarded to Jolla +##### Conditions for bugs to be forwarded to Jolla Until we have found a better heuristic, the 10 to-be-presented bugs are selected at random, with a slight bias towards new reports. -### Tagging +#### Jolla Team +##### Tagging Depending the situation, Jolla will tag as tracked, pending or fixed. +#### Reporters + + +**Solved** +The original reporter should mark the Bug Report post as "Solved": + - after verifying a "fixed" bug is actually fixed for them + - another explanation (e.g. not a bug, by design, ...) has been given + - another solution (e.g. satisfying workaround) has been found + +**Duplicates** +If a bug report is reported twice (or more). It should ideally contains the main bug report as comment and set as solution. +After, topic should be closed. + + ### Tools Once all these elements are checked, bug report will be tagged as Good and Jolla has only to sort bug reports to pick them and copy them to their internal bug tracker. Once this step is done, Jolla add the tracked tag. @@ -55,13 +73,13 @@ Tagged as good is currently defined as: the first post is liked by at least one After a new release and if a bug report is fixed, tag tracked is replaced with fixed. -## Duplicates -If a bug report is reported twice (or more). It should ideally contains the main bug report as comment and set as solution. -After, topic should be closed. --- ### Timeline @@ -81,6 +101,6 @@ Criteria for wellformed and relevant: 2022-03-31: "Better tracking of bug report" question raised in the [Mar 31 Collaboration Meeting](https://irclogs.sailfishos.org/meetings/sailfishos-meeting/2022/sailfishos-meeting.2022-03-31-07.00.html), @pherung steps up as coordinator 2022-03-31: [Announcement](https://forum.sailfishos.org/t/new-role-community-bug-coordinator/10935) on the Forum 2022-04-05: (private) [Internal Discussions](https://forum.sailfishos.org/t/re-new-role-community-bug-coordinator/11032) by the new coordinator team on how to proceed -2022-04-xx: VArious tools created to support the process +2022-04-xx: Various tools created to support the process 2022-04-xx: Forum Bug Report Template improved 2022-nn-nn: Process documented on docs.sailfishos.org From 4c6d86653f64329438d3dd25843dd3abec687c74 Mon Sep 17 00:00:00 2001 From: Peter G Date: Thu, 19 May 2022 12:31:54 +0200 Subject: [PATCH 4/6] Update Bug_Coordinators.md --- Develop/Collaborate/Community/Bug_Coordinators.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Develop/Collaborate/Community/Bug_Coordinators.md b/Develop/Collaborate/Community/Bug_Coordinators.md index 7484bc55..460a87b7 100644 --- a/Develop/Collaborate/Community/Bug_Coordinators.md +++ b/Develop/Collaborate/Community/Bug_Coordinators.md @@ -38,15 +38,24 @@ Starting with April 2022, members of the community support Jolla with coordinati ### Reponsibilities and Expectations #### CBC Team + +Scrutinize existing non-tracked bug reports. +Ensure "well-formed"ness. +Optionally, if possible try to reproduce. +Optionally, suggest to "solve"as duplicate if applicable + ##### The Coordinator's List -The team uses various tools and manual trawling of the forums to colloect (hopefully all) bug reports, and their well-formedness. +The team uses various tools and manual trawling of the forums to colloect (hopefully all) bug reports, and their well-formedness, and collect them in the "Coordinator's List". +This serves as a coordination tool as well as the base for forwarding to Jolla. ##### Conditions for bugs to be forwarded to Jolla Until we have found a better heuristic, the 10 to-be-presented bugs are selected at random, with a slight bias towards new reports. #### Jolla Team + +All the fuzz about well-formedness should make it easy ##### Tagging Depending the situation, Jolla will tag as tracked, pending or fixed. From 2075efe067aaa8e07e9df53ca390e5efc763ef53 Mon Sep 17 00:00:00 2001 From: nephros Date: Tue, 24 May 2022 09:23:26 +0200 Subject: [PATCH 5/6] Update Bug_Coordinators.md typos, consistent wording, better structuring --- .../Collaborate/Community/Bug_Coordinators.md | 70 +++++++++++-------- 1 file changed, 40 insertions(+), 30 deletions(-) diff --git a/Develop/Collaborate/Community/Bug_Coordinators.md b/Develop/Collaborate/Community/Bug_Coordinators.md index 460a87b7..f5a9dcee 100644 --- a/Develop/Collaborate/Community/Bug_Coordinators.md +++ b/Develop/Collaborate/Community/Bug_Coordinators.md @@ -11,77 +11,87 @@ Starting with April 2022, members of the community support Jolla with coordinati ### Lifecycle of a bug 1. A bug report is created by the user in the "Bug Reports" category - 2. Coordinators (and other forum members) work with the reporter to achieve "well-formed" status. - 3. Well-Formed bug reports are added to the Bug Coordination List - 4. About 10 Bug reports are picked to be presented in the Collaboration Meeting + 1. Coordinators (and other forum members) work with the reporter to achieve "well-written" status. + 1. well-written bug reports are added to the Bug Coordination List + 1. About 10 Bug reports are picked to be presented in the Collaboration Meeting - a couple of days before that, the list is submitted to the Collaboration Meeting coordination topic on the Forum - Jolla creates internal Bug reports or updates existing ones - - Jolla tags the Bug Report posts as "tracked" - 7. After a Sailfish OS Release which contains the fix for the bug, the Bug Report post is tagged as "fixed" - 8. The original reporter may at any time mark the Bug Report post as "Solved" - 9. The original reporter should mark the Bug Report post as "Solved" + - Jolla tags the Bug Report topic as "tracked" + 1. After a Sailfish OS Release which contains the fix for the bug, the Bug Report topic is tagged as "fixed" + 1. The original reporter may at any time mark the Bug Report topic as "Solved" + 1. The original reporter should mark the Bug Report topic as "Solved" - after verifying a "fixed" bug is actually fixed for them - another explanation (e.g. not a bug, by design, ...) has been given - another solution (e.g. satisfying workaround) has been found - the report has been identified as duplicate (see below) -#### Conditions for the report to be tagged as well-formed +#### Conditions for the report to be regarded as well-written * Bug report is written on the right category ("Bug Reports") * Important information are given (Device and Version) * Title is comprehensible * Description is provided * Expected result is provided * Step-by-step instructions for reproducing the bug are provided - * The first post contains the most recent information (important bits are not hidden in later posts) + * The first topic contains the most recent information (important bits are not hidden in later topics) ### Reponsibilities and Expectations #### CBC Team -Scrutinize existing non-tracked bug reports. -Ensure "well-formed"ness. -Optionally, if possible try to reproduce. -Optionally, suggest to "solve"as duplicate if applicable +Scrutinize existing non-tracked bug reports, or for other bug-report-like topics which should become bug reports. +Ensure it is "well-written", encouraging users to add information as required. +Optionally, if possible try to reproduce. +Optionally, suggest to "solve"as duplicate if applicable -##### The Coordinator's List +**The Coordinator's List** -The team uses various tools and manual trawling of the forums to colloect (hopefully all) bug reports, and their well-formedness, and collect them in the "Coordinator's List". -This serves as a coordination tool as well as the base for forwarding to Jolla. +The team uses various tools and manual trawling of the forums to collect +(hopefully all) bug reports, their well-written state, and collect them in the +"Coordinator's List". -##### Conditions for bugs to be forwarded to Jolla +This serves as a backlog, coordination tool as well as the base for forwarding to Jolla. -Until we have found a better heuristic, the 10 to-be-presented bugs are selected at random, with a slight bias towards new reports. +##### Submission at the Community Meeting + +Community Meetings at IRC, and their announcements at the Forum are used to make the Jolla team aware of the bugs. + +During the meeting, the list of bugs is presented, and a time slot allocated +for discussing them, requesting more information, and other action items. + +Until a better heuristic has been determined, the 10 to-be-presented bugs are +selected at random, with a slight bias towards new reports. #### Jolla Team -All the fuzz about well-formedness should make it easy +Creates internal Bug reports or updates existing ones from those presented at the Meeting. +Tags the Bug Report topic according to the internal bug's progress. + ##### Tagging -Depending the situation, Jolla will tag as tracked, pending or fixed. +Depending the situation, Jolla will tag the Bug Report topics as *tracked*, *pending* or *fixed*. -#### Reporters + - **tracked**: an internal bug report exists and is open + - **pending**: + - **fixed**: A SailfishOS version has been released which contains a fix for this bug. +#### Reporters **Solved** -The original reporter should mark the Bug Report post as "Solved": +The original reporter should mark the Bug Report topic as "Solved": - after verifying a "fixed" bug is actually fixed for them - another explanation (e.g. not a bug, by design, ...) has been given - another solution (e.g. satisfying workaround) has been found **Duplicates** -If a bug report is reported twice (or more). It should ideally contains the main bug report as comment and set as solution. -After, topic should be closed. +If a bug report is reported twice (or more). It should ideally contains the +main bug report as comment and set as solution. +After, the topic should be closed. ### Tools -Once all these elements are checked, bug report will be tagged as Good and Jolla has only to sort bug reports to pick them and copy them to their internal bug tracker. Once this step is done, Jolla add the tracked tag. - -Tagged as good is currently defined as: the first post is liked by at least one of the bug-coordinators. - -After a new release and if a bug report is fixed, tag tracked is replaced with fixed. - +TBW ;) --- From 56fa33fe095ff4117bbd9fb7ab440bde04555e8a Mon Sep 17 00:00:00 2001 From: nephros Date: Tue, 24 May 2022 09:45:19 +0200 Subject: [PATCH 6/6] Update Bug_Coordinators.md spelling and other things --- .../Collaborate/Community/Bug_Coordinators.md | 50 +++++++++++-------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/Develop/Collaborate/Community/Bug_Coordinators.md b/Develop/Collaborate/Community/Bug_Coordinators.md index f5a9dcee..e7ab2e0e 100644 --- a/Develop/Collaborate/Community/Bug_Coordinators.md +++ b/Develop/Collaborate/Community/Bug_Coordinators.md @@ -7,8 +7,8 @@ Starting with April 2022, members of the community support Jolla with coordinati - Improving transparency of internal bug handling - Improved communication about new bug reports - Improved bug report quality - -### Lifecycle of a bug + +### Life-Cycle of a bug 1. A bug report is created by the user in the "Bug Reports" category 1. Coordinators (and other forum members) work with the reporter to achieve "well-written" status. @@ -26,18 +26,18 @@ Starting with April 2022, members of the community support Jolla with coordinati - the report has been identified as duplicate (see below) -#### Conditions for the report to be regarded as well-written - * Bug report is written on the right category ("Bug Reports") - * Important information are given (Device and Version) +#### Conditions for the report to be regarded as "well-written" + * Bug report is submitted in the right category ("Bug Reports") + * Important information is given (Device, Version and other information from the Bug Report Template) * Title is comprehensible * Description is provided * Expected result is provided * Step-by-step instructions for reproducing the bug are provided * The first topic contains the most recent information (important bits are not hidden in later topics) -### Reponsibilities and Expectations +### Responsibilities and Expectations -#### CBC Team +#### Responsibilities of the CBC Team Scrutinize existing non-tracked bug reports, or for other bug-report-like topics which should become bug reports. Ensure it is "well-written", encouraging users to add information as required. @@ -54,28 +54,35 @@ This serves as a backlog, coordination tool as well as the base for forwarding t ##### Submission at the Community Meeting -Community Meetings at IRC, and their announcements at the Forum are used to make the Jolla team aware of the bugs. +Community Meetings held at IRC, and their announcements at the Forum are used +to make the Jolla team aware of the bugs. During the meeting, the list of bugs is presented, and a time slot allocated -for discussing them, requesting more information, and other action items. +for discussing them, requesting more information, and other action items. +To give everyone the opportunity to prepare for this, the bugs are previously +listed in the corresponding Meeting Announcement topic on the Forum. -Until a better heuristic has been determined, the 10 to-be-presented bugs are -selected at random, with a slight bias towards new reports. +Until a better heuristic has been determined, the to-be-presented bugs are +selected from the Coordinator's lists by picking 10 bugs reports at random, +with a slight bias towards new reports. -#### Jolla Team +#### Responsibilities of the Jolla Team -Creates internal Bug reports or updates existing ones from those presented at the Meeting. -Tags the Bug Report topic according to the internal bug's progress. +Create internal Bug reports or update existing ones from those presented at the +Meeting. +Tag the Bug Report topic according to the internal bug's progress, releases which contain the fix, and other applicable events. ##### Tagging Depending the situation, Jolla will tag the Bug Report topics as *tracked*, *pending* or *fixed*. - - **tracked**: an internal bug report exists and is open - - **pending**: - - **fixed**: A SailfishOS version has been released which contains a fix for this bug. + - **tracked**: An internal bug report exists and is open. + - **pending**: The bug report has been considered, but is neither tracked nor fixed. + - **fixed**: A Sailfish OS version has been released which contains a fix for this bug. + +#### Responsibilities of the Bug Reporter -#### Reporters +Reporters of original Bug Report topics should ideally be responsive to any updates to their report. They also should mark their report as Solved if applicable: **Solved** The original reporter should mark the Bug Report topic as "Solved": @@ -84,10 +91,8 @@ The original reporter should mark the Bug Report topic as "Solved": - another solution (e.g. satisfying workaround) has been found **Duplicates** -If a bug report is reported twice (or more). It should ideally contains the -main bug report as comment and set as solution. -After, the topic should be closed. - +If a bug report is found to be reported twice (or more), it should ideally contain the +main bug report as comment, and that comment set as the solution. ### Tools @@ -122,4 +127,5 @@ Criteria for wellformed and relevant: 2022-04-05: (private) [Internal Discussions](https://forum.sailfishos.org/t/re-new-role-community-bug-coordinator/11032) by the new coordinator team on how to proceed 2022-04-xx: Various tools created to support the process 2022-04-xx: Forum Bug Report Template improved +2022-04-28: Process fleshed out at [Community Meeting](https://irclogs.sailfishos.org/meetings/sailfishos-meeting/2022/sailfishos-meeting.2022-04-28-07.00.log.html) 2022-nn-nn: Process documented on docs.sailfishos.org