Bug Gardening
(Difference between revisions)
m |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | {| | + | {{Learning Activity Overview |
| − | + | |title= | |
| − | + | Bug Grooming / Bug Triage / Bug Zapping / Bug Wrangling | |
| − | | | + | |overview= |
| − | + | Most projects have a backlog of bugs that need to be periodically "gardened". Sometimes there are even old bugs that may have already been fixed that just haven’t been closed in the system. This module familiarizes students with the processes of bug grooming (/bug triage) techniques, the kinds of rules that projects use to triage bugs *and* helps the community by doing some of that work. | |
| − | | | + | |prerequisites= |
| − | + | Students should be familiar with how bug trackers work -- see [[Intro to Bug Trackers (Activity)]]. | |
| − | | | + | |objectives= |
| − | + | # Review a bug to see if it still is relevant. | |
| − | |} | + | # Explain the importance of "bug grooming". |
| + | |process skills= | ||
| + | }} | ||
=== Background === | === Background === | ||
| Line 23: | Line 25: | ||
This activity, however, is focused on retiring bugs that are no longer relevant (#5), primarily because that is more clear-cut than full-fledged bug triage. | This activity, however, is focused on retiring bugs that are no longer relevant (#5), primarily because that is more clear-cut than full-fledged bug triage. | ||
| − | Bug Triage Guides explain the rules for how to treat bugs within a project. Here are | + | Bug Triage Guides explain the rules for how to treat bugs within a project. Here are some examples of Bug Triage Guides: |
* [http://www.gluster.org/community/documentation/index.php/Bug_triage Gluster Bug Triage Guidelines] and their accompanying [http://www.gluster.org/community/documentation/index.php/Bug_report_life_cycle Lifecycle of a Bug] | * [http://www.gluster.org/community/documentation/index.php/Bug_triage Gluster Bug Triage Guidelines] and their accompanying [http://www.gluster.org/community/documentation/index.php/Bug_report_life_cycle Lifecycle of a Bug] | ||
* [https://www.mediawiki.org/wiki/Bug_management/How_to_triage Bug Management - How to Triage (MediaWiki)] | * [https://www.mediawiki.org/wiki/Bug_management/How_to_triage Bug Management - How to Triage (MediaWiki)] | ||
* [https://wiki.gnome.org/Bugsquad/TriageGuide Gnome Bug Triage Guide] | * [https://wiki.gnome.org/Bugsquad/TriageGuide Gnome Bug Triage Guide] | ||
| + | * [https://bugzilla.mozilla.org/page.cgi?id=etiquette.html Bugzilla "bug etiquette" guide] | ||
| − | + | If your project has a triage guide, read it first. If your project doesn't have a triage guide, I suggest contacting the project to find out if there is an established mailing list or IRC channel for discussing bugs. | |
| − | + | ||
| − | If | + | |
=== Directions === | === Directions === | ||
| Line 38: | Line 39: | ||
This activity is best performed in groups of two or three students. | This activity is best performed in groups of two or three students. | ||
| − | + | You should: | |
# Read the bug triage guide for your project (if available). | # Read the bug triage guide for your project (if available). | ||
# Join the IRC channel or mailing list for your project on which bugs are discussed. | # Join the IRC channel or mailing list for your project on which bugs are discussed. | ||
# Identify a "suspect" bug in the bug tracker, | # Identify a "suspect" bug in the bug tracker, | ||
| − | ##Identifying the "suspect" bugs will be easier if you have information from the project about their bug lifecycle or which bugs they | + | ## Identifying the "suspect" bugs will be easier if you have information from the project about their bug lifecycle or which bugs they suggest you focus on. However, even in the absence of that information, there are some other clues that can be used to identify bugs that may no longer exist. |
| − | ##Look at the version number of the software that the bug was reported against (versus the one that's current now). If the bug is for a version that's several releases out of date, there's a good likelihood that the issue may have been fixed (or may have just become irrelevant) in the meantime. | + | ## Look at the version number of the software that the bug was reported against (versus the one that's current now). If the bug is for a version that's several releases out of date, there's a good likelihood that the issue may have been fixed (or may have just become irrelevant) in the meantime. |
| − | ##Another possible hint is the date on the bug: bugs that were reported years ago may have been fixed and are probably worth looking at first. | + | ## Another possible hint is the date on the bug: bugs that were reported years ago may have been fixed and are probably worth looking at first. |
| − | # Test the bug to see if it still exists. Once | + | # Test the bug to see if it still exists. Once you have identified a bug to work on, try to verify the bug status. |
| − | ##At that point, if the bug is no longer relevant, | + | ## At that point, if the bug is no longer relevant, you can take one of several courses of action, depending on how well-established your relationship with the project is: |
| − | ###If | + | ### If you have established a good working relationship with a project and have permissions to do so, you can close the bug (this is something a more advanced student might do). |
| − | ### | + | ### You can add a comment to the bug with notes and a suggestion to close. This is more appropriate for students with less project experience. |
| − | ##If, after testing, | + | ## If, after testing, you cannot tell if a bug is still relevant -- that's ok. At that point you can: |
| − | ###Move on and try another bug, or | + | ### Move on and try another bug, or |
| − | ###Ask for more information from the bug reporter or the person assigned to the bug. This can be a valuable | + | ### Ask for more information from the bug reporter or the person assigned to the bug. This can be a valuable exposure to more of the project ecosystem. |
=== Deliverables === | === Deliverables === | ||
| Line 97: | Line 98: | ||
If you're working with a specific open source project '''and''' you have a block of time at least 1.5 hours long, you may want to run a bug sprint. You may be able to find a time when the regular "bug wrangler(s)" from the project can join you (via IRC or Google Hangout) and offer your students "live" assistance with triaging bugs. | If you're working with a specific open source project '''and''' you have a block of time at least 1.5 hours long, you may want to run a bug sprint. You may be able to find a time when the regular "bug wrangler(s)" from the project can join you (via IRC or Google Hangout) and offer your students "live" assistance with triaging bugs. | ||
| − | + | {{Learning Activity Info | |
| − | + | |acm unit= | |
| − | + | Software Development Fundamentals//Software Verification and Validation | |
| − | + | |acm topic= | |
| − | + | Defect tracking | |
| − | | | + | |difficulty= |
| − | + | Medium (requires some understanding of the intended functionality of the software, ability to use bug tracking software, and critical thinking skills). | |
| − | | | + | |time= |
| − | + | Not counting background reading, students should be able to find and "groom" a bug during an hour-long class. | |
| − | | | + | |environment= |
| − | + | Student needs access to the project's bug tracker, internet access. If your students will be making changes, they will also need to join the IRC channel or mailing list where bugs are discussed (the bug triage info should mention this), and if they are going to be making changes, they will need a login to the bug tracker. | |
| − | | | + | |author= |
| − | + | Gina Likins | |
| − | | | + | |source= |
| − | + | [http://blog.smartbear.com/programming/14-ways-to-contribute-to-open-source-without-being-a-programming-genius-or-a-rock-star 14 Ways to Contribute to Open Source without Being a Programming Genius or a Rock Star] | |
| − | | | + | |license= |
| − | + | {{License CC BY SA}} | |
| − | |} | + | }} |
=== Suggestions for the Open Source Project === | === Suggestions for the Open Source Project === | ||
| Line 122: | Line 123: | ||
If there are a set of bugs that it would be more helpful to have someone verify, then marking those in some way would help the instructor. | If there are a set of bugs that it would be more helpful to have someone verify, then marking those in some way would help the instructor. | ||
| − | + | [[Category:Learning Activity]] | |
| − | [[Category: | + | [[Category:Quality and Testing]] |
| − | [[Category: | + | [[Category:CS2]] |
| − | [[Category: CS2]] | + | |
Revision as of 14:16, 6 February 2017
| Title |
Bug Grooming / Bug Triage / Bug Zapping / Bug Wrangling |
|---|---|
| Overview |
Most projects have a backlog of bugs that need to be periodically "gardened". Sometimes there are even old bugs that may have already been fixed that just haven’t been closed in the system. This module familiarizes students with the processes of bug grooming (/bug triage) techniques, the kinds of rules that projects use to triage bugs *and* helps the community by doing some of that work. |
| Prerequisites |
Students should be familiar with how bug trackers work -- see Intro to Bug Trackers (Activity). |
| Learning Objectives |
After successfully completing this activity, the learner should be able to:
|
| Process Skills Practiced |
Background
Bug Gardening (or Grooming or Triage) is the process by which projects:
- confirm new bugs that have been submitted
- gather more information about the bug when necessary
- prioritize confirmed bugs
- review bugs to ensure that they are being worked on
- retire old bugs
This activity, however, is focused on retiring bugs that are no longer relevant (#5), primarily because that is more clear-cut than full-fledged bug triage.
Bug Triage Guides explain the rules for how to treat bugs within a project. Here are some examples of Bug Triage Guides:
- Gluster Bug Triage Guidelines and their accompanying Lifecycle of a Bug
- Bug Management - How to Triage (MediaWiki)
- Gnome Bug Triage Guide
- Bugzilla "bug etiquette" guide
If your project has a triage guide, read it first. If your project doesn't have a triage guide, I suggest contacting the project to find out if there is an established mailing list or IRC channel for discussing bugs.
Directions
Though all bugs need to be triaged (see examples of Bug Triage Guides), this activity is focused on culling bugs that are no longer relevant, primarily because that is more clear-cut than full-fledged bug triage.
This activity is best performed in groups of two or three students.
You should:
- Read the bug triage guide for your project (if available).
- Join the IRC channel or mailing list for your project on which bugs are discussed.
- Identify a "suspect" bug in the bug tracker,
- Identifying the "suspect" bugs will be easier if you have information from the project about their bug lifecycle or which bugs they suggest you focus on. However, even in the absence of that information, there are some other clues that can be used to identify bugs that may no longer exist.
- Look at the version number of the software that the bug was reported against (versus the one that's current now). If the bug is for a version that's several releases out of date, there's a good likelihood that the issue may have been fixed (or may have just become irrelevant) in the meantime.
- Another possible hint is the date on the bug: bugs that were reported years ago may have been fixed and are probably worth looking at first.
- Test the bug to see if it still exists. Once you have identified a bug to work on, try to verify the bug status.
- At that point, if the bug is no longer relevant, you can take one of several courses of action, depending on how well-established your relationship with the project is:
- If you have established a good working relationship with a project and have permissions to do so, you can close the bug (this is something a more advanced student might do).
- You can add a comment to the bug with notes and a suggestion to close. This is more appropriate for students with less project experience.
- If, after testing, you cannot tell if a bug is still relevant -- that's ok. At that point you can:
- Move on and try another bug, or
- Ask for more information from the bug reporter or the person assigned to the bug. This can be a valuable exposure to more of the project ecosystem.
- At that point, if the bug is no longer relevant, you can take one of several courses of action, depending on how well-established your relationship with the project is:
Deliverables
At the end of the exercise, the student teams should have a list of bugs that they investigated and the outcomes. In the ideal case, they will have been able to close a bug or two, but even if they haven't you should still receive a report out. I suggest the following as a sample format (I've filled two lines as examples):
| Bug Number | Short Description | Bug Status | URL for Bug | Analysis | Actions Taken |
| Bug 302338 | Machine Explodes on Disk Insertion | Active | http://example.com/fakebug.enter_bug.cgi?product=fake&bug=302338 | Bug submitted against version 2 of product, which was EOL'd in 2003 | Left comment suggesting that bug be closed |
| Bug 42984 | Funny Noises | Active | http://example.com/fakebug.enter_bug.cgi?product=fake&bug=42984 | Bug submitted in 2010, patched in release 2 (2011) | Closed bug. |
Assessment
| Criteria | Level 1 (fail) | Level 2 (pass) | Level 3 (good) | Level 4 (exceptional) |
| Ability to evaluate/triage bugs | Unable to correctly evaluate bug status | Evaluates bug status correctly | Evaluates bug status correctly and recommends correct action | Evaluates bug correctly, recommends correct action *and* suggests another bug that may be related (or makes another connection) |
Comments
If you're working with a specific open source project:
- ask the project (via IRC or mailing list) if there are a particular set of bugs that your students should focus on. For example, in the Gluster project I noted above, if a bug is tagged POST it means that an initial patch for a bug has been put into the Gerrit code review tool. If there is a very old bug that's marked POST, there's a decent likelihood that the patch has been incorporated into the project and the bug wasn't closed for whatever reason. If your students can verify this and close the bug, that's valuable.
- let the project know that your students will be doing this -- an influx of activity on a bug tracker can be overwhelming if unexpected
Other projects may have similar set-ups that are worth asking about.
Also: Make sure your project has enough old bugs for all your student teams :-)
Good Quiz Questions
- Name some reasons that bugs that could have been closed might still be open?
- Diagram the "normal" lifecycle of a bug for the project you're working on. Label the bug stages and who is involved at each stage.
- Find several bugs from your project: one that should be closed according to the criteria you're using (that are in the project's Bug Triage Guide, for instance), one that needs more information, and one that has the in correct status. Have students triage them and evaluate their success based on the criteria they site in the assessment as well as the resolution they suggest.
Variation If you're working with a specific open source project and you have a block of time at least 1.5 hours long, you may want to run a bug sprint. You may be able to find a time when the regular "bug wrangler(s)" from the project can join you (via IRC or Google Hangout) and offer your students "live" assistance with triaging bugs.
| ACM BoK Area & Unit(s) |
Software Development Fundamentals//Software Verification and Validation |
|---|---|
| ACM BoK Topic(s) |
Defect tracking |
| Difficulty |
Medium (requires some understanding of the intended functionality of the software, ability to use bug tracking software, and critical thinking skills). |
| Estimated Time to Complete |
Not counting background reading, students should be able to find and "groom" a bug during an hour-long class. |
| Environment / Materials |
Student needs access to the project's bug tracker, internet access. If your students will be making changes, they will also need to join the IRC channel or mailing list where bugs are discussed (the bug triage info should mention this), and if they are going to be making changes, they will need a login to the bug tracker. |
| Author(s) |
Gina Likins |
| Source |
14 Ways to Contribute to Open Source without Being a Programming Genius or a Rock Star |
| License |
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License
|
Suggestions for the Open Source Project
Your community should have specific expectations around [support] that are published [somewhere]. For example, if your code will only work on Fedora versions newer than 19, then specify that.
If there are a set of bugs that it would be more helpful to have someone verify, then marking those in some way would help the instructor.
