Write good issue reports

So, you are here to report an issue. We appreciate you reporting your concerns to us. We strive to ensure that you have an enjoyable working experience free from any issues or pesky errors. Please read the following information before reporting an issue for tips to help expedite the Issue Reporting process. The purpose of the issue report is to give us enough info to understand the problem you are getting and how it differs from your expectations.

Please help us by writing a good Issue Report.
When reporting issues, providing precise and clear information about the issue, your environment, steps to recreate the issue, and what the expected outcome should be. It will greatly help our team pinpoint the problem and provide a speedy resolution. If your issue report is effective, chances are higher that it will get fixed. So fixing an issue depends on how effectively you report it.

What are the qualities of good software issue report?

In a nutshell, the aim of a issue report is to enable programmers to see the program failing in front of them. You can hardly ever show them this in person so please give them careful and detailed instructions on how to make it fail. If they can make it fail, they will try to gather extra information until they know the cause. If they can’t make it fail, they will have to ask you to gather that information for them.

  • Try to reproduce the issue before reporting it.
    Developers will want to know anything you can find out about the problem. Try it twice or three times and see how often it fails. Try to remember as much detail as you can about what you were doing when it did fall over, and if you see any patterns, mention them. Anything you can provide has to be some help.
  • Write precise steps to reproduce.
    This is the most important part of any issue report. If we are able to reproduce the issue, the issue is very likely to be fixed. If the steps are unclear, it might not even be possible to know whether the issue has been fixed.

    • Imprecise: “Change the layer styling”.
    • Precise: “Open Layer Properties, click Display Query tab, choose Categories, pick a field and press Add All Values”.
  • Read the issue report before hitting Submit.
    Read all sentences, wording, steps used in the report. See if any sentence is creating ambiguity that can lead to misinterpretation. Misleading words or sentences should be avoided in order to have a clear issue report.