Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 131 additions & 0 deletions Develop/Collaborate/Community/Bug_Coordinators.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
## Community Bug Coordination

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 reports
- Improved bug report quality

### 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.
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 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 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)

### Responsibilities and Expectations

#### 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.
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 collect
(hopefully all) bug reports, their well-written state, and collect them in the
"Coordinator's List".

This serves as a backlog, coordination tool as well as the base for forwarding to Jolla.

##### Submission at the Community Meeting

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.
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 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.

#### Responsibilities of the Jolla Team

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**: 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 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":
- 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 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

TBW ;)

---

<!--
%%%% COMMENTED %%%%%
Notes/Copy from: https://mensuel.framapad.org/p/bugprocess-9tl3?lang=en by pherjung

# Process to achieve step 1
## Idea 1
Each 2 weeks, Community-Bug-Coordinators start with a list of 10 bugs report. We determine if each item has all necessary data and complete them if needed. Aim is to provide a clean list of bug report X days before community meeting so Jolla can easily import them and help us how to fetch more logs.

## Idea 2
Instead of waiting 2 weeks, we can use a private conversation for each bug report that's complicated or provide a list of difficult bugs on community meeting and Jolla will give some hint to catch more logs.

Thigg's script will then fetch all wellformed, relevant bugs for the community meeting.
Criteria for wellformed and relevant:
- liked by one of the bug-coordinators (thus the bug passed our wellformed check)
- not marked as solved (relevant)
- not tagged as tracked or solved (relevant)

%%%% COMMENTED %%%%%
-->

### 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-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