Reporting a Bug

before submitting new tickets:

  • Verify what version of Karamelo you are using, if you are using an older version try updating to the latest release.
  • Check the timeline to see if your bug has already been fixed in the trunk of our SVN repository.
  • Check our ticket tracker to see if your bug has already been reported.
  • Check the mailing list archives, to see if someone has already solved your problem.
  • Submit especific url where you find bug
  • Give us a brief description about what were you doing when bug appears

How to report a bug ¶

There are a small number of people who actually develop Karamelo. In between documentation, planning, answering questions, developing features for new releases, and sometimes pretending that they have lives outside of Karamelo ;-), bugs tend to be last on a very long todo list for them.

What does this mean for you, an aspiring bug reporter? In order to catch the eye of one of these few 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.

Please note the word volunteer, the people who are going to help you with a bug are volunteers. Not only are you not paying them to help you, but nobody else is either. So, be nice 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, what you were expecting, and why it didn't meet your expectations. If you don't tell us then we have to guess and we all know that this only ends in tears and recrimination for everyone. :)

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.

If you would like to create a patch or fix for the ticket, include it in diff format. Any patches not submitted in diff format will not be considered. Also note that any patches (or tickets without patches) that include unit tests that prove the issue will receive preferential treatment over those without (read: your bug will get fixed quicker).