Projects ⇒ Bugs ⇒ How to Report a Bug ⇒ CPG Dragonfly™ CMS
How to Report a Bug
There is a large number of users. There is a much small number of people who actually develop the languages and extensions. There is an even smaller number of people who actively fix bugs reported by users.
What does this mean for you, an aspiring bug reporter? In order to catch the eye of one of these few stalwart volunteers, you'll need to take to heart a few tips on how to report a bug so that they can and will help you.
Take special note of that word in bold above. The people who are going to help you with a bug you report are volunteers. Not only are you not paying them to help you, but nobody else is either. So, to paraphrase the immortal words of Bill and Ted, "be excellent to them".
Beyond that golden rule, what follows are some additional tips on ways to make your bug report better so that someone will be able to help you.
The basics: what you did, what you wanted to happen, and what actually happened.
Those are the three basic elements of a bug report. You need to tell us exactly what you did (for example, "The script calls make_happy_meal('hamburger','onion rings')") , what you expected to have happen (to continue the example, "I expected the script to serve me a happy meal with a hamburger and onion rings"), and what actually happened ("It gave me a happy meal with french fries.").
Yes, the example is silly. But if your bug report simply said "The make_happy_meal function doesn't work," we wouldn't be able to say "That's because you can't have onion rings in a happy meal, you can only have french fries or curly fries." By telling us what you asked for, what you expected to get, and what you actually got, we don't have to guess.
Always search the bug database first.
Advice so good, we'll repeat it twice. Always search the bug database first. As we said above, there's a lot of users. The odds are good that if you've found a problem, someone else has found it, too. If you spend a few minutes of your time making sure that you're not filing a duplicate bug, that's a few more minutes someone can spend helping to fix that bug rather than sorting out duplicate bug reports.
Try a SCM snapshot.
We will most likely ask you to try a SCM snapshot to verify whether the problem
has been fixed in our SCM repository or not. You can save yourself and us some
time if you first try to reproduce the bug with the latest snapshot.
If the bug still exists, then report a bug.
If you don't understand an error message, ask for help.
Don't report an error message you don't understand as a bug. There are places you can go for help:
(Now, once you've understood the error message, and have a good suggestion for a way to make the error message more clear, you might consider reporting it.)
Be brief, but don't leave any important details out.
This is a fine line to walk. But there are some general guidelines:
Yes, the user and developer communities are global and include a great many people who can speak a great many languages. But if you were to report a bug in a language other than English, many (if not most) of the people who would otherwise help you won't be able to. If you're worried about your English skills making it difficult to describe the bug, you might try asking for help on one of the community websites.
Don't report bugs about old versions.
Every time a new version of a Project is released, hundreds of bugs are fixed. If you're using a version of that is more than two revisions older than the latest version, you should upgrade to the latest version to make sure the bug you are experiencing still exists.
Only report one problem in each bug report.
If you have encountered two bugs that don't appear to be related, create a new bug report for each one. This makes it easier for different people to help with the different bugs.
Check out these other resources.