[Bug] How to write a quick and useful bug report

A good bug report needs four pieces of information to help us find, understand and fix the problems you share with us.

1. The behavior you unexpectedly encountered - One line is fine, and you can also use it as your post title (though remember to start your title with “[Bug]”). You may also paste a stacktrace or lines from the log here.

2. The behavior you were expecting to see - again, one line is fine.

3. A list of the steps you took that exposed the issue - including your starting point.

  • Open Perspective Designer’s project browser and select a component
  • Right-click …

4. A list of helpful information about the situation you were in, such as:

  • The Ignition version number (e.g. 8.0.0-beta1)
  • The browser and version number
  • The Module name and version number, if possible

That should do it. Thank you again for your interest in the Ignition 8 beta.

3 Likes

I would add to this two things:

  1. If you write “An error happened when…” make sure to tell us exactly what the error said.
  2. Perspective sessions have a lot going on in both the frontend (browser or designer) and the backend (gateway). When unexpected things are happening, check the browser’s console using the browser’s dev tools or the designer’s console, and also check the gateway’s console. Scripting errors, for example, will appear in the gateway’s logs, because all scripts & bindings are executed in the backend for perspective sessions.
4 Likes

One question though, which one will be a better approach reporting the bugs:

  1. Create a topic for each and every little bug or issues that I think could be a bug? or
  2. Combining all the little bugs under one topic at the end of the day?

Thanks,

One topic per bug will work better for us. See how we’re annotating the titles with numbers? Those correspond to IDs in our internal bug tracker.

3 Likes