Bug reporting is a very important part of any open source project. This allows the user to submit errors that they find in the software to the developers and thereby aid the developers in improving the software.
There are a few rules to bug reporting, however, in order to make it easier for both the users and the developers to keep track of the bugs and not run after duplicate or fixed bugs.
- Make sure your bug is repeatable:
Try to reproduce your bug about 3 times before going any further. - Go to the correct forum:
Within the bug reports forum there are 2 subforums. One is for the current stable version of Project HQ, and one is for the current development (or unstable) version. There is usually one sticky topic (a topic that remains at the top of the list) for the bug reports of the latest release of Project HQ. - Look to see if it has already been reported:
Look through that topic, and any other topics that people have posted, to see if your bug has already been reported. Only once you are sure it hasn't been reported yet should you report it yourself. - List your system specifications:
Make sure you list which browser you're using, what version of Python, Pylons and SQLAlchemy you have installed, what operating system, etc. - Explain the bug in full detail:
List all the steps up to the bug. Mention everything you did to recreate the bug. Include the full text of any error messages you get (even if you don't understand them, we do). - Follow up:
Check the forums, check the developers blogs, check the project page. The developers will see the bug reports, add them to the task list on the project page, and work on the bugs. Once they have fixed the bugs, they will list the task as complete.
