Fill out the report in the template
|
CS 471 Spring 2018 |
First Name: __________________ Last Name: __________________ |
Homework 1 – Bug Reports
Template – The text in red represents a placeholder providing additional instructions and should be removed from the final submission (i.e., final submission should not have any text in red)
Bug Report #1
Software system: TBD – e.g., Visual Studio Code
Link to bug report: e.g., https://github.com/Microsoft/vscode/issues/24410
Screenshot of bug report title and description:
TBD (remove sample screenshot below)
What I liked about this bug report (up to 3 short characteristics):
· TBD
· TBD
· TBD
What I would have liked this bug report to contain (up to 3 characteristics):
· TBD
· TBD
· TBD
If possible, how would you rewrite the title of the bug report to make it clearer and more informative?
TBD (write the new title here; do not attempt to make any changes to the original bug report)
If possible, how would you rewrite the description of the bug report to make it clearer and more informative?
TBD (write the new description here; do not attempt to make any changes to the original bug report)
Bug Report #2
Software system: TBD – e.g., Visual Studio Code
Link to bug report: e.g., https://github.com/Microsoft/vscode/issues/7426
Screenshot of bug report title and description:
TBD (see sample screenshot above)
What I liked about this bug report (up to 3 short characteristics):
· TBD
· TBD
· TBD
What I would have liked this bug report to contain (up to 3 characteristics):
· TBD
· TBD
· TBD
If possible, how would you rewrite the title of the bug report to make it clearer and more informative?
TBD (write the new title here; do not attempt to make any changes to the original bug report)
If possible, how would you rewrite the description of the bug report to make it clearer and more informative?
TBD (write the new description here; do not attempt to make any changes to the original bug report)
Feature Request #1
Software system: TBD – e.g., Visual Studio Code
Link to bug report: e.g., https://github.com/Microsoft/vscode/issues/396
Screenshot of bug report title and description:
TBD (see sample screenshot above)
What I liked about this feature request (up to 3 short characteristics):
· TBD
· TBD
· TBD
What I would have liked this feature request to contain (up to 3 characteristics):
· TBD
· TBD
· TBD
If possible, how would you rewrite the title of the feature request to make it clearer and more informative?
TBD (write the new title here; do not attempt to make any changes to the original bug report)
If possible, how would you rewrite the description of the feature request to make it clearer and more informative?
TBD (write the new description here; do not attempt to make any changes to the original bug report)
Page 4 out of 4
CS 471: Software Engineering
Spring 2018
Homework 1 – Bug Reports
Due date: Wednesday, January 24, 2018 (before the beginning of the class)
1. Brief Description
In order to understand how to write high quality bug reports that will be useful to your team,
1
you will need to gain experience with reading existing bug reports and learning how (not) to do
things. This homework provides you an opportunity to read existing bug reports for a project of your
choice and criticize / provide feedback.
2. Choose Active Projects with Issue Tracking Systems
You can choose bug reports from issue tracking systems of the projects listed below:
● https://github.com/Microsoft/vscode
● https://github.com/jquery/jquery
● https://github.com/torvalds/linux
● https://github.com/OpenRA/OpenRA
● https://github.com/tensorflow/tensorflow
● https://bugzilla.mozilla.org/
● https://bugs.eclipse.org/bugs/
● https://bugs.chromium.org/p/chromium/issues/list
Alternatively, you can choose any other “active” projects.
2
3. Choose Bug Reports and Provide Feedback
From the projects selected in previous section, choose one feature request and two bug reports
to discuss/examine/refine using the CS471_S18_HW1_Report_Template x template . 3
4. Submission
After filling in the template, generate a PDF and submit it via Blackboard (see HW1BugReports
assignment).
5. Grading Rubric
The maximum points for this homework representing 2% of the final grade is 100, and the points
are distributed as follows:
Item Points
Report presentation and format (e.g., all instructions in red are removed) 10
Bug Report #1
Name of software system and link to bug report 2
Screenshot of title and description 3
Enumerating good characteristics 5
Enumerating improvements 5
Rewriting title 5
Rewriting description 10
Bug Report #2
Name of software system and link to bug report 2
Screenshot of title and description 3
Enumerating good characteristics 5
1 https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines
2 For our homework, an “active” project should have thousands of commits and hundreds of contributors
3 A pdf template is also located under “Homework Assignments” at
https://piazza.com/boisestate/spring2018/cs471/resources
https://github.com/Microsoft/vscode
https://github.com/jquery/jquery
https://github.com/torvalds/linux
https://github.com/OpenRA/OpenRA
https://github.com/tensorflow/tensorflow
https://bugzilla.mozilla.org/
https://bugs.eclipse.org/bugs/
https://bugs.chromium.org/p/chromium/issues/list
https://piazza.com/class_profile/get_resource/jc5nwohipsapx/jc9e9g45p0f4jk
http://blackboard.boisestate.edu/
https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines
https://piazza.com/boisestate/spring2018/cs471/resources
Enumerating improvements 5
Rewriting title 5
Rewriting description 10
Feature Request #1
Name of software system and link to bug report 2
Screenshot of title and description 3
Enumerating good characteristics 5
Enumerating improvements 5
Rewriting title 5
Rewriting description 10