347
edits
Hacking:How To Report Valentina Bugs: Difference between revisions
no edit summary
No edit summary |
|||
Line 20:
# Select “Create issue”. This opens the actual entry form.
# Here you have to tell the developers everything about your system, your version of Valentina, and your bug. Just do your best to tell them about it. A crappy bug report is better than no report at all, but if you write down everything you can clearly, you will create a decent bug report.
##For “Title”, write a brief description of your bug. This title will help other users see if their bug might be like your bug. Write something that would help you if you were looking for a bug like yours.
##“Description” is the hard part. It is the actual bug report. First provide the detailed description of your bug: a brief overview of when it happened and exactly what went wrong (including error messages). Next, describe step-by-step how to reproduce the bug. Use the exact name of menu items. Describe tools, windows, and clicks as precisely as possible. If they can’t reproduce the bug, it will be very hard for them to fix it. Last, tell them anything else you can think of that might be relevant. This could include recently installed programs or hardware that might interfere with Valentina. Don't forget to add information about the version of Valentina in which you found the bug. It is the information you got with valentina --version. Sometimes it is very important to know which operating system you use. Bugs on Microsoft Windows, GNU/Linux GIMP or OS X are not always identical. It would be annoying to try to use a GNU/Linux for reproducing a OS X-specific bug. It is also useful to list the desktop or window manager you are using. Sometimes a problem is caused by an interaction between the two. It won’t always be relevant, but it is good to get into the habit of listing it anyway.
##Leave “Assignee” blank.
##Classify the “Kind” of your report. If you found a bug you should select "bug". You "enhancement" if you know how to make Valentina better. "Proposal" for reports where you can't be sure that it is really useful or not, but you still want to propose this. Use "task" if a report related to web site, documentation or any other infrastructure.
##Classify the “Priority” of your bug. If the bug causes Valentina to crash totally or do other really ucky things so you can’t use the program at all, classify it as critical. If it completely disables some part of Valentina, classify it as major (for example, keeps you from using a tool). Most bugs are “minor”. If you don’t know what priority to use, call it “minor”. Trivial bugs are annoying but don’t really keep you from using the program. Same priority have things like spelling errors or UI (User Interface, “the look and feel”) issues. Don’t worry if you choose the wrong priority. The people getting your bug report will adjust it. Don’t mark it higher than it really is just to get their attention.
##Select the appropriate “component”. If you don’t know what component it is, submit the bug under General. Descriptions of the components are [[Describe components|available]].
##Leave “Milestone” blank.
##Leave “Version” blank.
##Use "Attachments" if you have files or screenshots that could help in fixing a bug.
=== Enhancing Bug Reports ===
If someone has already reported a bug like yours, read the bug report carefully. Read through all the additional comments. Make sure every bit of information you know about the bug is in there. If your version is different or you had a slightly different experience with the bug, add a comment providing your information. Check the status of the bug carefully. If it is marked “WONTFIX”, see if you can provide the information needed. Do not add a “me too” comment unless your comment provides additional information that might be helpful for the developer.
If you have provided a bug report and later get more information (like a more specific error message or fancy stuff like a trace), add a comment to your original bug with that information. It is especially important to add a comment if you somehow resolve your bug. For example, you update something else on your system and the bug no longer appears. In that case, add a comment describing what you updated from what version to what version that resolved the bug.
=== The Wait Patiently Part ===
Whee!! You survived! If you managed to get through all this and submit your bug report, be happy. Be proud. You will later get e-mails about your bug. It might include a request for more information. If you get something that says your bug is not a bug, do not be discouraged from reporting in the future. Next time it might be. Submitting careful bug reports and providing additional information where possible helps make Valentina better. The day will come where you submit a bug and later get an e-mail that says your bug is “FIXED” or “RESOLVED”. Then you will know that some developer out there found your bug, reproduced it, and fixed it.
| |||