In this article, you will learn how to properly document a bug according to our rules and standards. In order to understand a bug, customers need sufficient information in a certain quality.

After finding the bug submission form, you have to select the right feature. Make sure the first dropdown shows the feature that you want to submit a bug report for. If you cannot find the right feature, go back to the test overview page and confirm the right one.

The whole bug form will now be visible to you and will look like for the functional bug type:

In the following sections, we will go over each field and explain in detail what you should enter and how.


Severity

For the bug type "Functional", you will see an extra option called "Severity" with between 1 and 3 buttons: Low, High, and/or Critical. The severity indicates the urgency of your report. It is made up of multiple factors. To select the appropriate severity for your bug, visit our separate article Functional Bugs.

The field "Severity" will not be displayed when you select bug types other than "Functional".


Title

The bug report title should be straightforward and precise!
It should contain the concerned element (e.g. search), broken functionality, and the origin in that order.

Wrong: No search results
Correct: Search results not displayed when entering a valid search on the homepage

Wrong: Filter XYZ does not work
Correct: When applying filter XYZ, the products don’t change order on the {category} details page
Note: “does not work” is always a bad description of the problem!


URL

Enter the URL of the webpage where the bug occurs into the URL field. Just visit the page before the bug appears and copy & paste the URL from your browser's URL field into the field "URL" in the bug report form.


Steps to reproduce

Bugs have to be reproducible and they need a detailed step-by-step guide on how they can be reproduced.
The first step must contain the URL in case of a web product or the app name in case of a mobile app. You do not need to number the steps, our system does that automatically.

Example:

  • Go to http://www.examplewebsite.com
  • Locate the search function in upper right corner
  • Enter any search subject, for example, “San Francisco”
  • Click on Search Now or hit the enter button

Remember that bugs should always reflect typical user behavior. This also includes user names you enter in some of your steps. Please use names that are actually words and don’t just “smash” your keyboard. Example: “asdlkfgjasdfkg lajsdhjasd”


Expected Result

The expected result of the steps you just described is to be entered in this field.
As always details are the key.

Wrong: Town name search function works.
Correct: After entering the town name “San Francisco”, I expect that available hotels in San Francisco would be displayed. If there are no such hotels, a message should be displayed, e. g. “There are no hotels available in your town”.


Actual Result

What actually happens after following the steps should be described as detailed as possible. This is really important because it describes the actual bug. 

Wrong: Town name search function doesn’t work.
Correct: After you click on “Search now”, nothing happens. No search results are displayed on a new browser page and the user doesn’t get any message or notification about what went wrong. The button “Search now” is without any functionality.


Tag

As of now, you can leave that field empty. It's a deprecated feature that we currently don't use. It might be removed in the future or we'll implement it differently.


Attachments

At least one attachment must be uploaded for every bug report. To learn what kind of attachment must be attached for your bug and what rules apply, please visit our article for requirements for bug report attachments.


Used environment

It’s important for us and our customer to know which device you experience the bug on. For a website test, click on the browser icon next to the device that you used. For a mobile app test, select the device that has the app installed.

You may only use devices to test the test environment that are listed in this section. Your device, browser, and/or operating system specification must match the device that you show on your attachments.

Make sure you select the right environment during the submission process because this is the only piece of information that cannot be changed afterwards – neither by your nor the team leader. Unfortunately, your report has to be rejected if you selected the wrong environment, but you can resubmit your bug if the test is still running and if no other tester already submitted the bug properly in the meantime.

You would like to test on a device that cannot be added to your profile? Send us a request via the support chat and we will check if your device is relevant for our customers.

Note: When you remove the device that you were invited for on your device list in your tester profile, you can no longer submit reports in that test. The environment section of the bug form will be empty and the form cannot be sent. Deleting a device in your profile cannot be reversed!


Straight rejection rule

Please invest enough time in documenting your bugs because team leaders will not improve your bug reports to reach the required level of quality; it's your job to provide sufficient information in a sufficient quality. If you are no longer a greenhorn tester, team leaders will have to straight-reject bug reports if one or more of the following cases is true for your bug report:

  • Several grammar mistakes (not just a typo)
  • Repeated improper feature choice
  • Overall bug report description not understandable
  • Unclear bug report title
  • Missing important steps
  • Tester clearly did not read or follow test instructions
  • Inconsistent evidence – when the discrepancy between steps and screencast is too large.
  • Incomplete evidence such as missing attachments including missing crash logs.

If one of your bug reports was rejected because the quality was not sufficient, you are allowed to submit it again with proper quality unless another tester already has already done so in the meantime.


Related articles:

Did this answer your question?