Bug report template - intive/patronage21-qa GitHub Wiki
Bug report procedure and template (Jira)
Steps to report a bug
- When inside the "intive – Patronage 2020/21 project", press the "C" key on your keyboard to open the "Create issue" window (see below). Be sure you're inside the "Bugs" board.
- Make sure that the "Issue type" field is set to "Bug".
- In the "Summary" textarea write the title of your bug. Remember that the title should be brief but precise, so that everyone should know what is this bug about before opening the details. For example, "Log in form doesn't work" isn't a precise title. "User cannot log in using valid username and password" is more specific.
- From the "Component/s" dropdown list select the component that the bug you're reporting is related to (Android, Java, JavaScript, QA).
- Fill the "Description" textarea as follows:
The first part – "Description" – is optional. If you think you can give all informations about the bug without using it, just don't write it and start from the "Environment" part.
- Set the proper bug priority from the "Priority" dropdown list, using only priorities listed below:
- In the "Labels" field add a proper label to the bug:
- the number of the Sprint in which the bug was found (Sprint1, Sprint2 etc.)
- Add the attachment to help developers find the bug. For rules regarding attachments, see the "Rules regarding attachments" section below.
- Set the "Assignee" field to "Unassigned".
- Click on the "Create" button.
Reporting a bug to the specific user story
If you know that the bug is connected to a specific user story, you can:
- Find and open that user story.
- Click on the "More" button.
- From the dropdown list select "Create sub-task".
- As the "Issue type" select "Sub-bug".
- Fill the rest of the "Create issue" window normally.
- Set the "Assignee" field to the creator of the user story that the sub-bug is connected to.
- Click on the "Create" button.
Rules regarding attachments
To help developers with reproducing bugs, you can attach: images, video recordings, logs or HAR files. Important: Before collecting logs remember to clear the DevTools console first, then reload the page from which you're starting bug reproduction and then go to next steps.
Image attachments
- image should show only the actual result, not all steps to reproduce the bug
- mark the bug with a rectangle with a red border, as on the image below:
Video attachments:
- accepted format: .mp4
- try to keep the video file duration below 1 minute
- don't record with sound if the bug you're reporting it's not related to the sound
- before recording make sure that cursor is highlighted and mouse clicks will be visible
- show only the last step to reproduce the bug. Very often there's no need to record all path leading to the actual result
- remember to keep video file size small. To shrink it if needed, use compression software like Handbrake