How to report bugs in mintTools

Write tutorials here
There are more tutorials here
Forum rules
Please don't add support questions to tutorials,start your own thread in the appropriate sub-forum instead. Before you post please read this
Post Reply
Level 8
Level 8
Posts: 2158
Joined: Thu Feb 26, 2009 8:58 pm

How to report bugs in mintTools

Post by emorrp1 » Wed Jun 17, 2009 7:26 am

In order for this forum to maintain its usefulness in speed of resolution, I think a few guidelines are needed (note that these are basically more strict versions of general forum etiquette):

Make sure it's a bug
This means searching the forums thoroughly and as the search box is next to useless, I recommend the mint forum google search: courtesy of altair. You should also be able to reproduce it on a clean system (e.g. Virtual machine/liveCD) to be sure it's not your configuration issue. If you don't have the technical no-how to identify the problem precisely, or even if you're just uncertain, post the problem in the support forum (preferably not the newbies section) so we can bash out the problem with you to get a more accurate understanding, enough to post a bug for. There's also a fine line between some feature suggestions and a bug, so be careful to check the suggestions forum too. Make sure someone hasn't reported the bug already! I know this is a common problem in the main forum, but it's especially important here, where multiple bug reports are just not helpful, and will delay the resolution, rather than speed it up.

Research thoroughly
Once you have found a bug, and confirmed it on a clean system, see if you can identify any similar areas where it might also happen, or a specific way it doesn't happen. Reading the source code can help with this, and since the mintTools are written in python and hence interpreted rather than compiled, you already have the source code, it's all saved under /usr/lib/linuxmint/ or if for any reason you want the full source package, enable the source repo in synaptic, and e.g. apt-get source mintupload. This can also help you decide whether it should just be a feature suggestion: If the code assumes certain behaviour contrary to your bug, then it's a bug; If the code is just missing something important, it's probably just a feature suggestion.

Topic titles
Include both tool name *and version* (preferably at the beginning), note that this won't leave much space for the problem description, so be precise. There are a number of prefixes you might find prepended to your post title as the bug report progresses:
[invalid] means the app developer had explained the bug away
[duplicate] means that the bug has already been reported
[confirmed] means the bug can be reproduced from a clean install
[solved] means a solution exists detailing the necessary source code changes
[fixed x.y.z] means the solution was released in version x.y.z

Detail the problem
Please provide as much info as possible, which you'll hopefully have gathered in the "Research" phase. A seemingly unimportant bit of related information may actually be the cause of the problem, so if in doubt include. An absolute minimum is the precise steps needed to reproduce the problem. If we can't find it, you haven't provided enough information and it'll slow down the resolution. Again, if you can't manage this, try posting in the support forums first.

Provide a solution
Obviously not always possible, but if you find a workaround, tell us, and if you find a solution, tell us. Preferably solutions should detail the necessary changes to the source code, since that should enable almost immediate response.

Hopefully this will be enough to make it easier for the developers to fix these bugs, but if anyone has any suggestions to improve the process, please post them below. Basically the idea is to make the bug reports useful to developers, without making the reporting process difficult for even intermediate users (e.g. ubuntu-bug/apport). Since problems could often be reported all over the support forums, this bugs forum should become a one-stop entry for developers to check out, so feel free to link to an original support topic if you're converting it into a bug. The idea is the devs should just be able to scan down the topic listing for their tool, and identify their most important bugs.
If you have a question that has been answered and solved, then please edit your original post and put a [SOLVED] at the end of your subject header
Hint - use a google search including the search term

Post Reply

Return to “Tutorials”