A bug report’s quality is determined by its written documentation and uploaded attachments (screenshots and screencasts).
The bug submission form should look like this:
All pieces of information should be entered as detailed and compact as possible.
The bug title should be straight and precise!
It should contain the concerned element, broken functionality, and origin.
Wrong: No search results
Correct: Search results not displayed when entering a valid search on the homepage
Wrong: Sometimes closing a window doesn’t work
Correct: Closing a window only works X out of Y times
Wrong: Filter XYZ does not work
Correct: When applying filter XYZ, the products don’t change order
Note: “does not work” is always a bad description of the problem!
Read our blog post “Writing the perfect bug title“
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 always has to 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.
- 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
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’ve expected that available hotels in the given town will be displayed. If there are no such hotels, a message should be displayed, e. g. “There are no hotels available in your town”.
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.
At least one attachment must be uploaded to every bug report.
You can read more about attachments here.
Remember that bugs should always reflect typical user behavior.
This also includes user names. Please use a name that is actually a name and don’t just “smash” your keyboard. Example: “asdlkfgjasdfkg lajsdhjasd” is not a valid name.