How to report bugs effectively

All bugs should first be reported to our dev mailing list. In case you need to ask a couple of quick questions while reporting the problem, you can do so on IRC. Please do not create new tickets in the issue tracker until you have been asked by a developer to.

When writing the report, in addition to the reproduction recipe, we’ll also need a complete description of the environment in which you reproduced the bug. That means:

  • Your operating system
  • The release and/or revision of Jitsi
  • The content of the Jitsi log folder
  • Anything else that could possibly be relevant. Err on the side of too much information, rather than too little.

Once you have all this, you’re ready to write the report. Start out with a clear description of what the bug is. That is, say how you expected Jitsi to behave, and contrast that with how it actually behaved. While the bug may seem obvious to you, it may not be so obvious to someone else, so it’s best to avoid a guessing game. Follow that with the environment description, and the reproduction recipe. If you also want to include speculation as to the cause, and even a patch to fix the bug, that’s great read instructions on sending patches.

Post all of this information to the dev mailing list, or if you have already been there and been asked to file an issue, then go to the Issue Tracker and follow the instructions there.

Thanks. We know it’s a lot of work to file an effective bug report, but a good report can save hours of a developer’s time, and make the bug much more likely to get fixed.

This document has been strongly influenced by Subversion’s “Reporting bugs” section