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

Ignition Early Access
1

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.

4 Likes
3

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
4

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,

5

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.

4 Likes
6

I know this is a very old thread, but it seems to be very relevant because I see countless [Bug Report] topics here in the forum that IA (sometimes) annotates with their corresponding number.

And yet, @pturmel keeps chastising members for doing so.

I have logged issues to IA support many times and they continue to be a huge help, but the reason I (and others I presume) choose to post it here is because:

  1. It's a minor issue that doesn't warrant a tech support inquiry
  2. It could help others be aware that IA knows about it and is addressing it (I don't see any [Bug xxxx] topics that are started by someone in Support)
  3. IA established the "precedent" with this post (even though it may have been more for the "Ignition Early Access" category)
  4. IA continues to respond and update [Bug] references

I have no problem adhering to any IA request to do otherwise, so if someone from IA can set me straight, I more than welcome it.

7

I think what @pturmel is trying to say is that you can post it here, but IA support isn't on the forums scanning for bug reports. To work with support about a bug you think you might have found, you have to open a ticket with support, and you can point them to the forum post, and they can post updates for others or even look at it for additional information.

The other thing is that some users come on here looking for support, and it's beyond what us volunteers are capable of. Sometimes it's even due to proprietary information that users would need to share that they probably don't want to or can't due to NDAs which support can handle.

2 Likes
8

This. My "chastizing" is not meant to be harsh, but simply to help you get resolution. The only group of users that really do need to use this forum for support are the Maker users, and there is a category for that.

2 Likes
9

I usually post on the forum and create a ticket and I'd recommend the same for you. I usually post on the forum to feel the room and see if anyone else is seeing the same thing. Then create a ticket for IA to get involved and they can update the forum post if needed.

2 Likes