This article describes how to use the "Submit a request" button to submit an bug with the Au-Zone software.
Preamble: What's a bug?
A "bug" is behavior in software, firmware, or hardware that is unexpected. This implies that:
- there is an expectation from you, the user, on how the application or device should work, and;
- you are observing something else.
From here, there are three very important things that you, the user, should have before writing a bug:
- What you are using: the software, firmware, hardware, with versions numbers and other identifying information that would make it easier for us to set up our test equipment to reproduce your bug.
- What you observed: what did you see, and what were you doing when you observed the issue? It is very important for us to know what steps you following when the issue happened, and specifically you saw that was unexpected.
- What did you expect: when you were working through your steps, what did you expect to happen? Sometimes, this can be very simple ("I expected the application to not crash").
How to Write a Bug
The first step is to click the "Submit a request" link at the top right of the web-page. That will take you to the Submit a request page.
On this page we'll enter the bug.
The "Subject" field is the title of your bug. It should contain three things: the software you were using, what you saw, and a brief -- even terse -- description of what you were doing when you caused the bug. Here are some good examples of this:
Deepview-creator crashes when validating on ONNX target
Modelrunner gives "Internal Error" with --help option
VAAL does nothing when following VAAL Quick Start Guide
Each of these follows the "what I was using" - "what I saw" - "what I was doing" format. After the Subject is entered, the support software will suggest articles that may address your issue. If you find one that seems hopeful, open it in another browser tab.
The description contains the rest of the bug text. Because of this, let's break that down into several, smaller pieces. Because the Description box does not contain any formatting, we recommend that you type each header IN CAPITAL LETTERS and on its own line to help us understand what is contained in each section.
This section contains what you saw and what you were doing when you saw this. There will be another section for the specific steps you were doing, so you can just describe your steps. If there is an error, please describe the error or note that a screen shot (Alt + PrtScn or Windows + Shift + S on Windows) below contains the error.
What you expected to happen when you observed the unexpected behaviour.
Write out the specific steps to follow to recreate this issue. It is preferable that you only include the minimal number of steps to recreate the issue. Sometimes we don't know which steps those are, and including all the steps is fine.
This section should contain version numbers, hardware information, and any other identifying information that may help us with our investigation into your bug. As well, feel free to any other information you think that would be helpful. Did other, similar tasks succeed? Does this issue happen every time you follow the steps or just occasionally or rarely? Did it work in a previous version? What was the text of the log messages?
Enter any screenshots or logfiles here. Please note that there is a maximum file size so some files may not fit.
Putting it all together
Click "Submit" when you are happy with your bug!