236
edits
GMU:Tutorials/Documentation/Bug Report How-To (view source)
Revision as of 14:33, 1 July 2016
, 1 July 2016no edit summary
(Created page with """How to report a bug"" ==Introduction== On this Wiki-page I'll try to explain how you can write a good bug report. The aim of a bug report is to enable the programmer to see ...") |
No edit summary |
||
| Line 1: | Line 1: | ||
How to report a bug | |||
==Introduction== | ==Introduction== | ||
| Line 34: | Line 34: | ||
There are several possibilities: | There are several possibilities: | ||
You can make a screen video of you reproducing the bug | |||
You can make screen shots and write information into them | 1. You can make a screen video of you reproducing the bug | ||
Write a detailed description of every click you made since you started the PC | |||
You could ask them to make a Skype or Teamviewer session with you to share your screen live | 2. You can make screen shots and write information into them | ||
5. If you weren't precise enough do it over again as they wish, or try some variations to get | |||
3. Write a detailed description of every click you made since you started the PC | |||
4. You could ask them to make a Skype or Teamviewer session with you to share your screen live | |||
5. If you weren't precise enough do it over again as they wish, or try some variations to get to the same point were you actually wanted to be. | |||
6. If its a graphical problem you're confronted with tell them exactly in wich order you | 6. If its a graphical problem you're confronted with tell them exactly in wich order you | ||
pressed the buttons, if its a problem writing commands they need to know exactly what | |||
commands you typed and what the computer outputted as response. | |||
7. If you're loading the data from a specific file you created send them over to them. | 7. If you're loading the data from a specific file you created send them over to them. | ||
8. If you're using the program to talk to another via Network Computer you also need to | 8. If you're using the program to talk to another via Network Computer you also need to | ||
send them the specs of the other on too | |||
==Works for them but not for you…== | ==Works for them but not for you…== | ||
| Line 51: | Line 58: | ||
If the programmer recreated your commands/inputs/actions/… and it works for them you may haven't given them enough information. Maybe the error doesn't appear on every Computer. | If the programmer recreated your commands/inputs/actions/… and it works for them you may haven't given them enough information. Maybe the error doesn't appear on every Computer. | ||
Or you have got it wrong what the program is should do and is able too, so it maybe that you got it right but for your opinion its turning out wrong. | Or you have got it wrong what the program is should do and is able too, so it maybe that you got it right but for your opinion its turning out wrong. | ||
1. Provide the information of what your intention was by using the program. | 1. Provide the information of what your intention was by using the program. | ||
2. Tell them what exactly happened | 2. Tell them what exactly happened | ||
3. Tell them what you thought it should happen | 3. Tell them what you thought it should happen | ||
4. Tell them exactly what Error message you saw | 4. Tell them exactly what Error message you saw | ||
5. Are there unexplainable delays and when | 5. Are there unexplainable delays and when | ||
At this point the programmer still wants to reproduce your failure, they need to know what and where it has gone wrong. Write the errors down message and number are equally important, even if the computer cant give you out the information in words theres still important information in numbers or signs he's outputting. | At this point the programmer still wants to reproduce your failure, they need to know what and where it has gone wrong. Write the errors down message and number are equally important, even if the computer cant give you out the information in words theres still important information in numbers or signs he's outputting. | ||
| Line 71: | Line 84: | ||
==Sometimes it works…== | ==Sometimes it works…== | ||
If you're confronted with a bug that just occurs from time to time try to search for a pattern in it. | If you're confronted with a bug that just occurs from time to time try to search for a pattern in it. Try different setups several times and write down how many times the bug occurred and what differs to the times it was working. | ||
Where you using an extra large file | |||
Did some other program access the file at the same time | 1. Where you using an extra large file | ||
3. | |||
4. | 2. Did some other program access the file at the same time | ||
5. | |||
3. Are you running any other programs you weren't running the last time | |||
6. | |||
4. Do you use another display or beamer then before | |||
5. Maybe you're just stressed cause of a deadline and weren't using the software carefully | |||
enough. | |||
6. What version of the program you are using with wich version of your operating system | |||
| Line 98: | Line 117: | ||
1. Let the programmer see what you've seen | 1. Let the programmer see what you've seen | ||
2. If they cant see it failing themselves describe what went wrong | 2. If they cant see it failing themselves describe what went wrong | ||
3. Describe everything in Detail | 3. Describe everything in Detail | ||
4. Tell them what you saw and what you were expecting to see | 4. Tell them what you saw and what you were expecting to see | ||
5. Write down the Error messages | 5. Write down the Error messages | ||
6. When something unexpected happens leave the Situation like that until you're calm | 6. When something unexpected happens leave the Situation like that until you're calm | ||
7. Describe the symptoms don't make a diagnosis | 7. Describe the symptoms don't make a diagnosis | ||
8. Provide the programmer with any extra information he needs | 8. Provide the programmer with any extra information he needs | ||
9. Tell them you're version numbers | 9. Tell them you're version numbers | ||
10. Be specific and write in clear language | 10. Be specific and write in clear language | ||
11. Be sure you're description cant be misinterpreted | 11. Be sure you're description cant be misinterpreted | ||