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"
(Fixed grammar.) |
|||
| 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 remain assigned to platform-swt-inbox@eclipse.org. | 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. | ||
| Line 18: | Line 18: | ||
<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 | + | 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 === | === Triage checklist === | ||
| Line 24: | Line 24: | ||
* Check for duplicate bugs | * Check for duplicate bugs | ||
| − | * Set/update | + | * Set/update Metadata correctly |
* Link to relevant bugs | * Link to relevant bugs | ||
* Briefly investigate if bug is real (i.e, reproducible on latest master) | * Briefly investigate if bug is real (i.e, reproducible on latest master) | ||
| Line 33: | Line 33: | ||
* [Optionally] try to bisect codebase for regression reports | * [Optionally] try to bisect codebase for regression reports | ||
| − | === Setting proper | + | === Setting proper Metadata === |
* For severity and priority, see: [[WTP/Conventions_of_bug_priority_and_severity]]. | * 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 | + | ** 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> | * Prefix OS and Component to bug summary. <br> | ||
** OS: [gtk][gtk2][gtk3][Wayland][Cocoa][Win32] | ** OS: [gtk][gtk2][gtk3][Wayland][Cocoa][Win32] | ||
| Line 64: | Line 64: | ||
To construct the queries above: | To construct the queries above: | ||
| − | Open an incognito browser. (so that everything is hard-coded into | + | 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: | 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 | ||
* :swt @platform-swt-inbox@eclipse.org -!Triaged os:All,Linux,CentOS -os:Windows | * :swt @platform-swt-inbox@eclipse.org -!Triaged os:All,Linux,CentOS -os:Windows | ||
| − | * etc | + | * etc. |
Columns were changed, such that the following were kept: | Columns were changed, such that the following were kept: | ||
| Line 80: | Line 80: | ||
== 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 | ||
Revision as of 12:17, 20 June 2017
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 are considered active but are not currently being worked on. These bugs are available for anyone in the community to work on.
When you take ownership of the bug (i.e you intend to work on the bug), you can assign it to yourself. When you start working on the bug, you can set the status to "ASSIGNED".
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/java
- 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][StylepdText][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).
- ex: [gtk3][Theme] Button background not styled.
- Prefix regressions with [Regression]
- Set appropriate target milestone if we plan to fix it within a particular time frame. You should check with a developer first though.
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