This module focuses on the components of the writing a good bug report. Reporting bugs in a helpful way helps the developers fix bugs and helps software to be more useful.
1. You will know what the basic components of a good bug report are.
2. You will be able to write a good bug report.
1. Play the SIL Giving Feedback to LSDev presentation. Press the space bar to move to the next slide.
2. Read the following internet articles.
3. Do the exercises at the end of the presentation.
Do the following exercises. They are the same ones given in the presentation.
1. Write a description of how to get some program into a particular state. If it’s helpful, you can create a folder with any files you think might help. If you know of a current bug, try to describe how to make it happen. Keep the window open showing the final state. See if someone else can follow your directions. Were your directions followed successfully? What was helpful and unhelpful?
2. The next time someone comes to you with a problem you think is a bug… Have them write it up. See if you can follow their instructions to make it happen. If not, and if they are patient enough, see if you can ask questions and get them to improve the description so you can. Ideally do not have them just show you. When the report is clear enough so you can reproduce it, send it in.
3. The next time you discover a bug, write your best description of how to reproduce it. Give it to a colleague and see whether they actually can make it happen. Improve it until you can give it to someone who hasn’t tried it before and they succeed. Submit it
Discuss your experience with your mentor.
Answer the following three questions and review your answers with your mentor.
1. What makes a good bug report?
2. What are the components of a good bug report?
3. Report a software bug in a language technology app to the developers. Describe the steps you took to do this. Describe the interaction you had with the developers. What was the resolution?