Category:Update a Tracker Issue (Pathway)

From Foss2Serve
(Difference between revisions)
Jump to: navigation, search
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
  
−
'''The contributor will''': study and attempt to update a tracker issue (e.g. a bug report or feature request) to identify missing information, provide additional information, or resolve the issue.  
+
'''The contributor will''': study and try to update a tracker issue (e.g. a bug report or feature request) to identify missing information, provide additional information, or resolve the issue.  
  
 
'''The contribution is''': updated information about the issue, which could make it easier to address.
 
'''The contribution is''': updated information about the issue, which could make it easier to address.
Line 31: Line 31:
 
{| {{Pathway Step Table}}
 
{| {{Pathway Step Table}}
 
|-
 
|-
−
| 1. Select a tracker issue to update. For example:
+
| 1. Select a tracker issue to update. For example, the issue might be:
−
# an issue identified by the HFOSS community as appropriate for students.
+
: a. Identified by the HFOSS community as appropriate for students.
−
# an issue identified (and possibly assigned) by the instructor.
+
: b. Identified (and possibly assigned) by the instructor.
−
# an issue selected by the student.
+
: c. Selected by the student.
−
| You have selected an issue.
+
| You selected an issue.
 
|
 
|
 
| [[Bug Selection]]
 
| [[Bug Selection]]
 
|-
 
|-
−
| 2. Study the issue details and identify aspects that could be clarified.
+
| 2. Study the issue details, and identify aspect(s) that could be improved.
−
: a. How could the issue's ''description'' be clarified?
+
: a. How could the ''description'' of the issue be improved?
−
:: i. for a bug report, it is clear what goes wrong, and how to reproduce it?
+
:: i.   For a bug report, it is clear what the problem is, and how to reproduce it?
−
:: ii. for a feature request, it is clear what could be better, and how it might work?
+
:: ii. For a feature request, it is clear what the benefit is, and how it might work?
−
: b. How could the issue's ''impact'' be clarified?
+
:: iii. How many users are affected, and how important is it to them?
−
:: i. How many users are affected?
+
 
−
:: ii. How important is it to these users?
+
: b. How could ''solution(s)'' to the issue be improved?
−
: c. How could the issue's ''scope'' be clarified?
+
:: i.   Are actual solution(s) available? (e.g. branch, patch, list of steps)
−
:: i.  What code, documentation, database, etc would be changed?
+
:: ii.  How well are potential solution(s), if any, described?
−
:: ii. How difficult will these changes be?
+
::  iii. What code, documentation, database, etc would be changed?
−
| You have identified one or more aspects that could be clarified.
+
:: iv. How difficult would these changes be?
 +
 
 +
| You identified one or more aspects that could be improved.
 
|
 
|
 +
* [[:Category:Information Processing|Info Proc]]
 +
* [[:Category:Written Communication|Writ Comm]]
 
|
 
|
 +
[[Research Bug Activity]]
 
|-
 
|-
−
| 3. Choose an aspect and try to clarify it.
+
| 3. Choose an aspect and improve it.
−
: a. If the ''description'' is unclear:
+
: a. To improve the ''description'':
−
:: i. Search for more details - was the issue discussed in IRC, forums, other issues, etc?
+
:: i.   If the issue is a bug report, try to [[:Category:Verify a Bug (Pathway)|Verify a Bug]].
−
:: ii. Specify what is unclear and ask the reporter to clarify.
+
::  ii. If the issue is a feature request, provide more detailed requirements (e.g. text description, UML, mockup, storyboard, paper prototype).
−
: d. If the issue is a bug report, try to [[:Category:Verify a Bug (Pathway)|Verify a Bug]].
+
::  iii. For a complex issue, consider whether it should be split into several smaller issues.
−
: e. If the issue is a feature request, try to  
+
 
−
|
+
:  b. To improve the ''solution(s)'':
−
|
+
::  i.  If actual solution(s) are available, try to use them, and describe if and how well they work.
 +
::  ii.  Try to identify which code, documentation, database, etc. would be changed.
 +
::  iii. Try to estimate how difficult the changes would be.
 +
::  iv.  For a complex solution, consider whether it should be split into several smaller issues.
 +
 
 +
| You clarified one or more aspects.
 
|
 
|
−
|-
+
* [[:Category:Problem Solving|Prob Solv]]
−
| 1. Read the bug report on the issue tracker.
+
−
: i. If there is enough information to reproduce the bug. continue to step 2.
+
−
: ii. Otherwise, use the issue tracker to ask the reporter for more information.
+
−
: '''Exception:''' Couldn’t understand the report: ask the reporter for additional information using the issue tracker
+
−
| Decision to proceed to the next step or a request for more information in the issue tracker.
+
−
|
+
−
* [[:Category:Information Processing|Info Proc]]
+
 
* [[:Category:Written Communication|Writ Comm]]
 
* [[:Category:Written Communication|Writ Comm]]
 
|
 
|
 +
[[Reproduce a Bug Activity]]
 
|-
 
|-
−
| 2. Reproduce the bug
+
| 4. If you get stuck and cannot improve the description or solution(s), look for more information.
−
: i. Run the program
+
: a. Search for more details - was it discussed in IRC, forums, other issues, etc? Do other projects have similar issues? Summarize what you found.
−
: ii. Follow the steps outlined in the bug report. If the steps cannot be followed, use the issue tracker to ask the reporter for clarification.
+
: b.  Describe what is unclear and ask the reporter(s) or FOSS community for input.
−
: '''Exception:''' Procedure in bug report could not be followed: ask reporter for clarification using the issue tracker
+
| You have provided or asked for more information.
−
: iii. Observe the program’s behavior
+
|
−
| Observation of program behavior or a request for more information in the issue tracker.
+
−
|  
+
 
* [[:Category:Information Processing|Info Proc]]
 
* [[:Category:Information Processing|Info Proc]]
−
* [[:Category:Critical Thinking|Crit Think]]
 
 
* [[:Category:Written Communication|Writ Comm]]
 
* [[:Category:Written Communication|Writ Comm]]
 
|
 
|
−
[[Reproduce a Bug Activity]]
 
 
|-
 
|-
−
| 3. Report results on the issue tracker
+
| 5. Update the issue tracker with your clarifications. Optionally, repeat steps 3,4,5 to clarify other aspects.
−
| Report posted to issue tracker.
+
:  a. Indicate if you believe the issue is ''resolved'' (can't reproduce, already done, duplicate issue, etc) - you may or may not have permission to change the issue status.
 +
:  b. Indicate if you plan to ''start'' or ''stop'' work on the issue e.g. claim or watch the issue, assign it to yourself, etc.
 +
| You posted an update to the issue tracker.
 
|  
 
|  
 
* [[:Category:Written Communication|Writ Comm]]
 
* [[:Category:Written Communication|Writ Comm]]
−
|
+
|[[Write a Bug Report (Activity)]] Part 3
−
Part of [[Reproduce a Bug Activity]]
+
 
|}
 
|}
  

Latest revision as of 00:20, 9 March 2017


The contributor will: study and try to update a tracker issue (e.g. a bug report or feature request) to identify missing information, provide additional information, or resolve the issue.

The contribution is: updated information about the issue, which could make it easier to address.

Prerequisites

Area The contributor must be able to:
Software Configuration
  • Run the program.
  • Possibly: Download and install the development environment.
Issue Tracker
  • Describe issue trackers and how they are used.
  • Access the issue tracker with appropriate permissions.
  • Read, create, and update issues in a tracker.
Community
  • Describe the community guidelines for management and triage of issues (bug reports and feature requests).

Pathway Steps, Outcomes, & Learning Activities

Follow the project’s policies and practices to complete the steps below.

Pathway Step Step Outcome Process Skills Focus Related Learning Activities
1. Select a tracker issue to update. For example, the issue might be:
a. Identified by the HFOSS community as appropriate for students.
b. Identified (and possibly assigned) by the instructor.
c. Selected by the student.
You selected an issue. Bug Selection
2. Study the issue details, and identify aspect(s) that could be improved.
a. How could the description of the issue be improved?
i. For a bug report, it is clear what the problem is, and how to reproduce it?
ii. For a feature request, it is clear what the benefit is, and how it might work?
iii. How many users are affected, and how important is it to them?
b. How could solution(s) to the issue be improved?
i. Are actual solution(s) available? (e.g. branch, patch, list of steps)
ii. How well are potential solution(s), if any, described?
iii. What code, documentation, database, etc would be changed?
iv. How difficult would these changes be?
You identified one or more aspects that could be improved.

Research Bug Activity

3. Choose an aspect and improve it.
a. To improve the description:
i. If the issue is a bug report, try to Verify a Bug.
ii. If the issue is a feature request, provide more detailed requirements (e.g. text description, UML, mockup, storyboard, paper prototype).
iii. For a complex issue, consider whether it should be split into several smaller issues.
b. To improve the solution(s):
i. If actual solution(s) are available, try to use them, and describe if and how well they work.
ii. Try to identify which code, documentation, database, etc. would be changed.
iii. Try to estimate how difficult the changes would be.
iv. For a complex solution, consider whether it should be split into several smaller issues.
You clarified one or more aspects.

Reproduce a Bug Activity

4. If you get stuck and cannot improve the description or solution(s), look for more information.
a. Search for more details - was it discussed in IRC, forums, other issues, etc? Do other projects have similar issues? Summarize what you found.
b. Describe what is unclear and ask the reporter(s) or FOSS community for input.
You have provided or asked for more information.
5. Update the issue tracker with your clarifications. Optionally, repeat steps 3,4,5 to clarify other aspects.
a. Indicate if you believe the issue is resolved (can't reproduce, already done, duplicate issue, etc) - you may or may not have permission to change the issue status.
b. Indicate if you plan to start or stop work on the issue e.g. claim or watch the issue, assign it to yourself, etc.
You posted an update to the issue tracker. Write a Bug Report (Activity) Part 3

Notes for Learning Activities Related to this Pathway

When creating activities:

  1. Use examples to demonstrate concepts to student.
  2. Use screen shots when possible.
  3. Prompt students to indicate the exact steps taken to replicate the bug.

This category currently contains no pages or media.

Retrieved from "http://foss2serve.org/index.php?title=Category:Update_a_Tracker_Issue_(Pathway)&oldid=9744"
Personal tools
Namespaces
Variants
Actions
Events
Learning Resources
HFOSS Projects
Evaluation
Navigation
Toolbox