Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "SWT/Devel/Triage"
m |
(→Setting proper Metadata) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
== Triage Process Overview == | == Triage Process Overview == | ||
| − | The goal of | + | The goal of “Triage” is a '''quick''' initial response to incoming bug submissions from users.<br> The intent is for users to receive initial feedback on their submission and for bugs to be categorized properly. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | If the bug has sufficient information, then add the "'''Triaged'''" Keyword to it and optionally leave some message for the user e.g "Thank you for bug submission, we should investigate". The bug status should remain "NEW" and | + | If the bug has sufficient information, then add the "'''Triaged'''" Keyword to it and optionally leave some message for the user e.g "Thank you for bug submission, we should investigate". The bug status should remain "NEW" and remain assigned to platform-swt-inbox@eclipse.org. |
Subsequently, when we look for new bugs to work on, we can check bugs that have the "Triaged" keyword (See queries below). <br> | Subsequently, when we look for new bugs to work on, we can check bugs that have the "Triaged" keyword (See queries below). <br> | ||
| − | + | All the triaged bugs with assignee as platform-swt-inbox@eclipse.org and status=NEW are considered active but are not currently being worked on. These bugs are available for anyone in the community to work on. <br> | |
| + | Assign "helpwanted" keyword if contributions from public is welcomed.<br><br> | ||
| + | The purpose of Status is to tell bug readers if someone is working on a bug or not:<br> | ||
| + | - Status=NEW means that nobody is working on a bug, you can start work on it.<br> | ||
| + | - Status=ASSIGNED means someone is already working on the bug. (But in real life sometimes bugs are forgotten, so old 'ASSIGNED' bugs should be treated as NEW). <br> | ||
| + | I.e when work has started on a bug, (either by you, or patch is being provided by community), then the status can be set to "ASSIGNED". If for some reason work stops and requires a new contributor, the status should be returned back to "NEW". | ||
| + | |||
| + | See the following diagram:<br> | ||
[[File:Platform-Triage-Process-v2.png|thumbnail|left]] | [[File:Platform-Triage-Process-v2.png|thumbnail|left]] | ||
| + | <br> | ||
| + | <br> | ||
| + | <br> | ||
| + | <br> | ||
| + | <br> | ||
| + | <br> | ||
| + | <br> | ||
| + | As a swt developer, consider [https://devzing.com/blog/index.php/bugzilla-tip-have-bugzilla-email-me-when-another-person-is-assigned-a-bug/ watching] platform-swt-inbox@eclipse.org in Bugzilla, to get notifications about new and triaged bugs. | ||
| + | === Triage checklist === | ||
| + | Use the following as a guideline on how to triage a bug: | ||
| + | * Check for duplicate bugs | ||
| + | * Set/update Metadata correctly | ||
| + | * Link to relevant bugs | ||
| + | * Briefly investigate if bug is real (i.e, reproducible on latest master) | ||
| + | * Ask user to test with newer version if reported version is very old | ||
| + | * Request versions of SWT/OS/Gtk/Webkit. Note, Gtk/Webkit versions can be aquired by [https://bugs.eclipse.org/bugs/show_bug.cgi?id=519124 setting version variable] : | ||
| + | export SWT_LIB_VERSIONS=1 | ||
| + | eclipse | ||
| + | * Request a snippet (or clear steps to reproduce) if it's not clear as to how to reproduce issue | ||
| + | * Ping/CC developers involved in related issue (especially when regressions occur) | ||
| + | * [Optionally] try to bisect codebase for regression reports | ||
| + | === Setting proper Metadata === | ||
| + | * For severity and priority, see: [[WTP/Conventions_of_bug_priority_and_severity]]. | ||
| + | ** Set appropriate priority. In general, we leave severity as set by user, but we can adjust it as well. Ex for enhancements set "enhancement". | ||
| + | * Prefix OS and Component to bug summary. <br> | ||
| + | ** OS: [GTK][GTK2][GTK3][Wayland][Cocoa][Win32] | ||
| + | ** Component: [PI][Graphics][Theme][Accessibility][Printing][DnD][Clipboard][OpenGL][Browser][StyledText][Layout][Examples][Snippets][JUnit][64][I18N][AWT][HiDPI][Custom widgets][Bidi] | ||
| + | ** Note: | ||
| + | *** PI means Native library interface. | ||
| + | *** 64 means 32/64 bit issues. | ||
| + | *** I18N means Internationalization issues. | ||
| + | *** BiDi means Bi-directional text | ||
| + | ** ex: [GTK3][Theme] Button background not styled. | ||
| + | * Bug reports which are regressions can make use of the "regressions" keyword | ||
| + | * Set appropriate target milestone if we plan to fix it within a particular time frame, check with a committer if unsure | ||
| + | == Triage Bugzilla Queries == | ||
| + | === New Bugs === | ||
| + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=product%2Ccomponent%2Cpriority%2Cvotes%2Cbug_severity%2Ctarget_milestone%2Cbug_status%2Cresolution%2Cshort_desc%2Cchangeddate%2Cstatus_whiteboard%2Ckeywords%2Copendate%2Cversion&field0-0-0=product&field0-0-1=component&field1-0-0=assigned_to&field2-0-0=keywords&no_redirect=1&order=votes%20DESC%2Cbug_status%2Cpriority%2Cassigned_to%2Cbug_id&query_based_on=&query_format=advanced&type0-0-0=substring&type0-0-1=substring&type1-0-0=substring&type2-0-0=nowords&value0-0-0=swt&value0-0-1=swt&value1-0-0=platform-swt-inbox&value2-0-0=Triage Highest voted bugs] | ||
| + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=product%2Ccomponent%2Cpriority%2Cvotes%2Cbug_severity%2Ctarget_milestone%2Cbug_status%2Cresolution%2Cshort_desc%2Cchangeddate%2Cstatus_whiteboard%2Ckeywords%2Copendate%2Cversion&field0-0-0=product&field0-0-1=component&field1-0-0=assigned_to&field2-0-0=keywords&no_redirect=1&query_based_on=&query_format=advanced&type0-0-0=substring&type0-0-1=substring&type1-0-0=substring&type2-0-0=nowords&value0-0-0=swt&value0-0-1=swt&value1-0-0=platform-swt-inbox&value2-0-0=Triage All] | ||
| + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=product%2Ccomponent%2Cpriority%2Cbug_severity%2Cvotes%2Cbug_status%2Cstatus_whiteboard%2Ctarget_milestone%2Cshort_desc%2Cop_sys%2Cchangeddate%2Copendate%2Ckeywords%2Ctag%2Creporter%2Cversion&field0-0-0=product&field0-0-1=component&field1-0-0=assigned_to&field2-0-0=keywords&field3-0-0=op_sys&field3-0-1=op_sys&field3-0-2=op_sys&field4-0-0=op_sys&order=priority%2Cvotes%20DESC%2Cbug_severity%2Ctarget_milestone%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on=&query_format=advanced&type0-0-0=substring&type0-0-1=substring&type1-0-0=substring&type2-0-0=nowords&type3-0-0=substring&type3-0-1=substring&type3-0-2=substring&type4-0-0=notsubstring&value0-0-0=swt&value0-0-1=swt&value1-0-0=platform-swt-inbox%40eclipse.org&value2-0-0=Triaged&value3-0-0=All&value3-0-1=Linux&value3-0-2=CentOS&value4-0-0=Windows All and Linux, CentOS] | ||
| + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=product%2Ccomponent%2Cpriority%2Cvotes%2Cbug_severity%2Ctarget_milestone%2Cbug_status%2Cresolution%2Cshort_desc%2Cchangeddate%2Cstatus_whiteboard%2Ckeywords%2Copendate%2Cversion&f0=OP&f1=OP&f10=CP&f11=OP&f12=OP&f13=keywords&f14=CP&f15=CP&f2=product&f3=component&f4=CP&f5=CP&f6=OP&f7=OP&f8=assigned_to&f9=CP&j1=OR&j12=OR&j7=OR&o13=nowords&o2=substring&o3=substring&o8=substring&op_sys=Windows%20All&op_sys=Windows%2095&op_sys=Windows%2098&op_sys=Windows%202000&op_sys=Windows%20Server%202003&op_sys=Windows%20Server%202008&op_sys=Windows%207&op_sys=Windows%208&op_sys=Windows%2010&op_sys=Windows%20CE&op_sys=Windows%20ME&op_sys=Windows%20Mobile%202003&op_sys=Windows%20Mobile%205.0&op_sys=Windows%20NT&op_sys=Windows%20XP&op_sys=Windows%20Vista&op_sys=Windows%20Vista-WPF&order=priority%2Cvotes%20DESC%2Cbug_severity%2Ctarget_milestone%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on=&query_format=advanced&v13=Triage&v2=swt&v3=swt&v8=platform-swt-inbox All and Win32] | ||
| + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=product%2Ccomponent%2Cpriority%2Cvotes%2Cbug_severity%2Ctarget_milestone%2Cbug_status%2Cresolution%2Cshort_desc%2Cchangeddate%2Cstatus_whiteboard%2Ckeywords%2Copendate%2Cversion&f0=OP&f1=OP&f10=CP&f11=OP&f12=OP&f13=keywords&f14=CP&f15=CP&f2=product&f3=component&f4=CP&f5=CP&f6=OP&f7=OP&f8=assigned_to&f9=CP&j1=OR&j12=OR&j7=OR&o13=nowords&o2=substring&o3=substring&o8=substring&op_sys=Mac%20OS%20X%20-%20Carbon%20%28unsup.%29&op_sys=Mac%20OS%20X&query_format=advanced&v13=Triage&v2=swt&v3=swt&v8=platform-swt-inbox All and Cocoa] | ||
| − | === | + | === Triaged bugs === |
| − | + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=product%2Ccomponent%2Cpriority%2Cvotes%2Cbug_severity%2Ctarget_milestone%2Cbug_status%2Cstatus_whiteboard%2Cshort_desc%2Ckeywords%2Ctag%2Clongdescs.count%2Cchangeddate%2Copendate%2Creporter&field0-0-0=product&field0-0-1=component&field1-0-0=assigned_to&field2-0-0=keywords&no_redirect=1&order=priority%2Cvotes%20DESC%2Cbug_severity%2Ctarget_milestone%20DESC%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on=&query_format=advanced&type0-0-0=substring&type0-0-1=substring&type1-0-0=substring&type2-0-0=anywords&value0-0-0=swt&value0-0-1=swt&value1-0-0=platform-swt-inbox&value2-0-0=Triaged All] | |
| + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=product%2Ccomponent%2Cpriority%2Cbug_severity%2Cvotes%2Cbug_status%2Cstatus_whiteboard%2Ctarget_milestone%2Cshort_desc%2Cop_sys%2Cchangeddate%2Copendate%2Ckeywords%2Ctag%2Creporter%2Cversion&field0-0-0=product&field0-0-1=component&field1-0-0=assigned_to&field2-0-0=keywords&field3-0-0=op_sys&field3-0-1=op_sys&field3-0-2=op_sys&field4-0-0=op_sys&order=priority%2Cvotes%20DESC%2Cbug_severity%2Ctarget_milestone%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on=&query_format=advanced&type0-0-0=substring&type0-0-1=substring&type1-0-0=substring&type2-0-0=nowords&type3-0-0=substring&type3-0-1=substring&type3-0-2=substring&type4-0-0=notsubstring&value0-0-0=swt&value0-0-1=swt&value1-0-0=platform-swt-inbox%40eclipse.org&value2-0-0=Triaged&value3-0-0=All&value3-0-1=Linux&value3-0-2=CentOS&value4-0-0=Windows All, Linux, CentOS, Unix] | ||
| + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Eclipse&component=SWT&keywords=triaged%2C%20&keywords_type=allwords&op_sys=All&op_sys=Windows%20All&op_sys=Windows%2095&op_sys=Windows%2098&op_sys=Windows%202000&op_sys=Windows%20Server%202003&op_sys=Windows%20Server%202008&op_sys=Windows%207&op_sys=Windows%208&op_sys=Windows%2010&op_sys=Windows%20CE&op_sys=Windows%20ME&op_sys=Windows%20Mobile%202003&op_sys=Windows%20Mobile%205.0&op_sys=Windows%20NT&op_sys=Windows%20XP&op_sys=Windows%20Vista&op_sys=Windows%20Vista-WPF&order=Importance&product=Platform&query_format=advanced All, Windows] | ||
| + | * [https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Eclipse&component=SWT&keywords=triaged%2C%20&keywords_type=allwords&op_sys=All&op_sys=Mac%20OS%20X%20-%20Carbon%20%28unsup.%29&op_sys=Mac%20OS%20X&product=Platform&query_format=advanced All, Cocoa] | ||
| − | + | === Query Construction === | |
| − | + | To construct the queries above: | |
| − | + | ||
| − | + | ||
| − | + | Open an incognito browser. (so that everything is hard-coded into URL) | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | Use [https://bugs.eclipse.org/bugs/page.cgi?id=quicksearch.html quick search]. For example: | |
| − | + | * :swt @platform-swt-inbox@eclipse.org -!Triaged | |
| − | * | + | * :swt @platform-swt-inbox@eclipse.org -!Triaged os:All,Linux,CentOS -os:Windows |
| − | + | * etc. | |
| − | * | + | |
| + | Columns were changed, such that the following were kept: | ||
| + | * Product, Component, Priority, Severity, Votes, Status, Whiteboard, Target Milestone, Summary, OS, Changed, Opened, Keywords, Tags, Reporter, Version, # of comments | ||
| + | * "Stagger Headers" was used. | ||
| + | Then result was sorted in desired order: Priority, Votes, Severity, Target Milestone | ||
| + | URL was copied. | ||
== History == | == History == | ||
| − | In the past, triaged bugs were re-assigned from a platform-swt-inbox@eclipse.org to a stw-triaged@eclipse.org user. Instead we now just add the "Triage" keyword. | + | In the past, triaged bugs were re-assigned from a platform-swt-inbox@eclipse.org to a stw-triaged@eclipse.org user. Instead, we now just add the "Triage" keyword. |
In the distant past, bugs were assigned to component owners, but that lead to component owners to have large amount of bugs that they did not actually work on. | In the distant past, bugs were assigned to component owners, but that lead to component owners to have large amount of bugs that they did not actually work on. | ||
Some projects used to use platform-inbox, but to mark a bug as triaged, the "ASSIGNED" status was used. But this could lead to confusion where users could think that | Some projects used to use platform-inbox, but to mark a bug as triaged, the "ASSIGNED" status was used. But this could lead to confusion where users could think that | ||
Latest revision as of 15:25, 25 June 2018
Contents
Triage Process Overview
The goal of “Triage” is a quick initial response to incoming bug submissions from users.
The intent is for users to receive initial feedback on their submission and for bugs to be categorized properly.
If the bug has sufficient information, then add the "Triaged" Keyword to it and optionally leave some message for the user e.g "Thank you for bug submission, we should investigate". The bug status should remain "NEW" and remain assigned to platform-swt-inbox@eclipse.org.
Subsequently, when we look for new bugs to work on, we can check bugs that have the "Triaged" keyword (See queries below).
All the triaged bugs with assignee as platform-swt-inbox@eclipse.org and status=NEW are considered active but are not currently being worked on. These bugs are available for anyone in the community to work on.
Assign "helpwanted" keyword if contributions from public is welcomed.
The purpose of Status is to tell bug readers if someone is working on a bug or not:
- Status=NEW means that nobody is working on a bug, you can start work on it.
- Status=ASSIGNED means someone is already working on the bug. (But in real life sometimes bugs are forgotten, so old 'ASSIGNED' bugs should be treated as NEW).
I.e when work has started on a bug, (either by you, or patch is being provided by community), then the status can be set to "ASSIGNED". If for some reason work stops and requires a new contributor, the status should be returned back to "NEW".
See the following diagram:
As a swt developer, consider watching platform-swt-inbox@eclipse.org in Bugzilla, to get notifications about new and triaged bugs.
Triage checklist
Use the following as a guideline on how to triage a bug:
- Check for duplicate bugs
- Set/update Metadata correctly
- Link to relevant bugs
- Briefly investigate if bug is real (i.e, reproducible on latest master)
- Ask user to test with newer version if reported version is very old
- Request versions of SWT/OS/Gtk/Webkit. Note, Gtk/Webkit versions can be aquired by setting version variable :
export SWT_LIB_VERSIONS=1 eclipse
- Request a snippet (or clear steps to reproduce) if it's not clear as to how to reproduce issue
- Ping/CC developers involved in related issue (especially when regressions occur)
- [Optionally] try to bisect codebase for regression reports
Setting proper Metadata
- For severity and priority, see: WTP/Conventions_of_bug_priority_and_severity.
- Set appropriate priority. In general, we leave severity as set by user, but we can adjust it as well. Ex for enhancements set "enhancement".
- Prefix OS and Component to bug summary.
- OS: [GTK][GTK2][GTK3][Wayland][Cocoa][Win32]
- Component: [PI][Graphics][Theme][Accessibility][Printing][DnD][Clipboard][OpenGL][Browser][StyledText][Layout][Examples][Snippets][JUnit][64][I18N][AWT][HiDPI][Custom widgets][Bidi]
- Note:
- PI means Native library interface.
- 64 means 32/64 bit issues.
- I18N means Internationalization issues.
- BiDi means Bi-directional text
- ex: [GTK3][Theme] Button background not styled.
- Bug reports which are regressions can make use of the "regressions" keyword
- Set appropriate target milestone if we plan to fix it within a particular time frame, check with a committer if unsure
Triage Bugzilla Queries
New Bugs
Triaged bugs
Query Construction
To construct the queries above:
Open an incognito browser. (so that everything is hard-coded into URL)
Use quick search. For example:
- :swt @platform-swt-inbox@eclipse.org -!Triaged
- :swt @platform-swt-inbox@eclipse.org -!Triaged os:All,Linux,CentOS -os:Windows
- etc.
Columns were changed, such that the following were kept:
- Product, Component, Priority, Severity, Votes, Status, Whiteboard, Target Milestone, Summary, OS, Changed, Opened, Keywords, Tags, Reporter, Version, # of comments
- "Stagger Headers" was used.
Then result was sorted in desired order: Priority, Votes, Severity, Target Milestone
URL was copied.
History
In the past, triaged bugs were re-assigned from a platform-swt-inbox@eclipse.org to a stw-triaged@eclipse.org user. Instead, we now just add the "Triage" keyword.
In the distant past, bugs were assigned to component owners, but that lead to component owners to have large amount of bugs that they did not actually work on.
Some projects used to use platform-inbox, but to mark a bug as triaged, the "ASSIGNED" status was used. But this could lead to confusion where users could think that