This article presents a requirement for our freelancers. Failure to follow the process might represent a breach of the Freelancer Services Agreement.
Creating an Issue Report With Testlio
When testing an app, if a step Fails or it is not possible to test the step due to an issue, the testers can report a new issue. Before reporting a new issue, the testers need to make sure that their issue is not a duplicate of an issue that has been reported already. See how to look for duplicates.
In order to create a quality report for the new issue, think of:
The Problem – Make sure that your title and description are focused on the problem and not the less important details.
Length – Keep your report short, simple, and focused so that it is easy to follow and understand.
Proof – Make sure to include screenshots, videos, and logs so that we can confirm what happened.
Related Issues – Are there other actions that could cause the same problem? Are they relevant to mention in your report?
Guidelines About How To Fill Different Fields in an Issue Report
1. Issue Title
The title of an issue should have the [Affected feature] Title of the issue
First, specify the affected feature between the [ ] brackets
Add the title of the issue without brackets
Please, do not put a dot at the end of the title
Common Mistakes Made With the Issue Title
Typos in issue titles
Improvement Needed | Good Example |
[Email] Ap crashes when clicking on “Add title” | [Email] App crashes when clicking on “Add title”
|
Titles Are Grammatically Wrong
Punctuation at the end of the title is not needed
Improvement Needed | Good Example |
[New issue] New issue fail when, response is shown error 503. | [New issue] Creating new issue fails with error code 503 |
[Chat] No notification when try send PM. | [Chat] Notification is not shown when sending a private message
|
Titles Are Confusing/Too Complex
Users want to see titles that are easily understandable.
Issue titles should follow the “failure - when” style and indicate the following things:
Exact failure reason
The conditions under which it fails
Issue severity should be understood when reading the title
Improvement Needed | Good Example |
[Working On] Inviting people to file search wrong results until rotating screen | [Working on] Can’t invite people to search files - have to rotate the screen before the option becomes visible |
Title Does Not Explain the Full Impact of the Issue
The issue title should explain the full impact of the issue, so that issue importance, severity, and priority could already be understood when reading the title.
Improvement Needed | Good Example |
[Chat] Error appears when posting a message | [Chat] Error appears when posting message, although message is sent successfully |
Title Is Not Generalized
Sometimes some of the reported issues can be a sub-case of either an already existing issue or only 1 case of some more general problem. This should always be checked and when possible, the title should be written as generalized as possible.
Improvement Needed | Good Example |
[Feed] Error appears when posting private feed update containing ‘<‘ symbol | [Feed] Error appears when posting public or private feed update with html tags |
2. The Severity of the Issue
Testers can select the severity of the issues based on the explanations below:
High: Anything that blocks the use of the app or has a significant negative effect on the normal user flow. For example:
[Login] User is not able to sign in after restoring the network
[Chat] App crashes and the user is logged out after unfriending the user and sending a message
Medium: Issues that have a heavy negative effect on the user experience, in general, would be medium. For example:
[Notification Stream] New private message notification stays in-stream even when the user has read the message
[Sign in] App freezes after tapping the Next button to Sign In and twice changing the device orientation
Low: Typos, missing icons, layout issues, etc. are considered to be low severity issues. For example:
[Calendar] The background of the 'Delete' confirmation window becomes blank (white) after restoring the app from the background
[Game] When entering a name to a new game the text cursor is not shown clearly on the screen
3. Affected Feature
When a tester is testing a specific app, the Affected feature dropdown list will show different features of that app.
4. Labels
Similar to the Affected feature list, the Labels dropdown list will also change depending on the app. You can select the option that describes the situation.
5. Environment details
In this section, provide the following details about your testing environment:
Your device and OS
App version
Network
Location
Reproducibility rate (Good practice is to try reproducing the issue at least 3 times.)
Any requirements noted in the specific workspace
Please note that you need to provide your environment details every time you report a new issue.
6. Steps to Reproduce
Make sure to list the exact steps to reproduce the issue without skipping any steps.
Use > symbol to indicate the navigation from one step to the next
Keep it simple and easy to follow.
The first step should be the prerequisites someone needs before they can follow your repro steps
In most cases, where a login is required to use the app, you don’t need to mention it as a separate step.
[Bad example] Steps to reproduce:
Open app
Log in with valid credentials
Tap on Settings
On the displayed options select Profile
Tap on Edit in the top right corner
Tap on Profile Image
Select an image saved on the phone
Select Upload
Tap on Save Changes
[Good example] Steps to reproduce:
0. Prerequisite: Log in with valid credentials
1. Settings > Profile > Edit
2. Change Profile picture > Save
7. Expected Result
Write a precise summary about what is the expected result in this situation.
8. Actual Result
Write a quick note about what is the actual result and what is broken
9. Attachments
It is really important to attach some supporting documents (screenshots, recordings, logs, etc.) with every issue report to provide the team with proof of how the issue is occurring on your end.
Attachment naming: A good practice for attachment naming is to name it with a phrase that describes the issue. This helps the developer who downloads the attachments to diagnose the issue.
Attachments for Visual issues (UI): Visual issues that are stationary are often easy to display with a screen recording and screenshot which highlight the problematic behavior
Attachments for Functionality issues: We require two attachments with every issue report for the issues that affect the functionality of the application.
Video: Many visual issues happen when switching between screens, or need a motion to be understood. When this happens, screenshots are not sufficient and you need to record a video. See how to record your screen including requirements on what to do.
Logs: Logs allow developers to dig deep into the root of the issue to see exactly what went wrong on your device. Many crashes and errors are not easy to reproduce. Without a crash or console log, your report will not provide much value. See how to capture logs.
Example of a Good Issue Report
![A screenshot of an issue being created. The title is "[Invite People] Keyboard is not opened after tapping the 'Name' field. All the other sections are completed and there are two attachments, one an image and the other a .mp4 video file.](https://downloads.intercomcdn.com/i/o/984688694/cc68967fb8437e3a09dd0c15/A-Good-Issue-Report_Example.png?expires=1733343300&signature=20491bbe0000d62d9b86ecffc1dd58a96c5b7f0a3c1b1776f1a4e32db54ed0a4&req=fSgjEMF2m4hbFb4f3HP0gFvL77h9qH8p5VxEoH6KpM5QVOJCEwGPpcxkbwn6%0AwXd3aipgr89cIncD4w%3D%3D%0A)
#TestlioBot