Reporting bugs - a guide
It's vital that once you find a problem, you try and reproduce it more then once, then list the steps how to reproduce it. Sometimes bugs are hard to reproduce, but pretty much all bugs can be repeated once you work out the steps to get there - and what our programmers need are the shortest number of steps to repeat the problem from when the app is started.
It's only when one tries to repeat a problem, that one finds that some of the steps that led up to the problem are not related to it.
It's easy for bug reports to be too vague, or have a number of steps that are unrelated to the problem which only go to slow down the bug fixing process.
When we come to fix a bug, we must first reproduce the problem. Then as we investigate, we must to reproduce the problem repeatedly in order to establish the conditions and find the cause. Once we think we've fixed the problem, we need to go through the steps again to verify that we've fixed it. So an accurate and succinct procedure to reproduce the problem is really vital.
Summary
- If you find a problem, stop. Try and reproduce the problem from scratch i.e. by closing the app and trying again. Be as methodical as possible.
- Once you've found the shortest number of steps to reproduce the problem repeatedly, then submit a bug report from the application using the FILE menu (Report Bugs to eJamming)
- Please make sure that the e-mail address you use to create your eJamming AUDiiO account ID on the log in screen is one which you check regularly, as the programmers may want to reply to your bug reports if some of the information in your report is unclear.
HERE’S AN EXAMPLE HOW TO REPORT A BUG THAT WOULD BE MOST HELPFUL FOR THE PROGRAMMING TEAM:
Title: Crash when recording an audio track a second time
Steps to reproduce:
1. Start app
2. Create a Session with an audio track
3. REC enable audio track
4. Record 30 secs of audio
5. Stop transport and rewind
6. Start recording, crash occurs after 10 seconds
To report bugs, select "Report Bugs to eJamming..." in the file menu, fill out the details and click "Send".
This sort of report really helps us. It's short, precise, gives us plenty of information and tells us step by step what you did. It's really important to fine tune the report to ensure that you communicate no less and no more than is necessary in order to help the team fix the problem.
Thank you for wanting to help us.