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:
- Use examples to demonstrate concepts to student.
- Use screen shots when possible.
- Prompt students to indicate the exact steps taken to replicate the bug.
This category currently contains no pages or media.
