A good bug report can make everyone happy

Quick checks before reporting a bug:

  1. Can you reproduce the bug or was it only one time
  2. Has anyone else reported the same bug
  3. Include only one problem per bug
  4. Check other platforms and browsers as well
    a) If the bug is found on chrome, check other browsers .
    b) If the same application has a mobile app, be sure to check the app.
    c) If a bug is on IOS application, check its Android version
  5. If the bug is not occurring again, clear the cookies or refresh the cache and then try again
  6. For more information for the developer, open the developer’s console , check for console errors. If there are, take a screenshot

List of Items to be included in an ideal bug report

1. Title

The title should serve as a concise summary of the bug .

Tip: Use this title template
[Actual error or issue] is displayed when user [the action performed on which the bug occurred].

Instead of “Login form not loading due to 500 error”, the title could be
500 error is displayed when the user clicks on Login button”

2. Steps to reproduce

Steps to reproduce are the most important part of a bug report. A good description clearly mentions the steps to reproduce the bug. Trust me, if a developer is able to understand and reproduce the bug, it not only saves time but its likely to be fixed sooner.

Tips: a) The steps should be written while keeping in mind that person reading. it has no information about the project.
b) In order to include each step without making the description lengthy, use “>” symbol.
c) Don’t make generic statements. Be specific for the steps to be followed to avoid any confusion.
d) With each step performed, mention the expected result

Example for steps 500 error is displayed when clicked on login button:
Bad example:
1) Open the website
2) Add values in the form fields
3) Click Login button
Result: 500 error is displayed
Good example:
1) Open the website
— User name and password fields are displayed at the footer
2) Enter the username > “test123”
3) Enter password > “Test123"
— Login button is enabled
4) Tap on Login button
Result: 500 error is displayed

3. Environment

Sometimes it happens that a bug is observed on one platform and not on the other . So it is best to mention clearly the environment in which the bug was detected. The OS and browser configuration is necessary for a clear bug report. Developers will use that information to narrow down the commit what introduced a regression

Tips: a) For UI bugs occurring on machines, its good to mention the resolution of your screen.
b) If the bug is occurring on Mobile app, mention the device name along with OS versions.
c) Don't forget to mention the browser name, for browser-specific bugs.

4. Expected Result/Actual Result

A description is incomplete without the expected and actual results. It is necessary to outline what is the outcome of the test and what the user should expect.

An example for the 500 error displayed on tapping login button is:
Actual result
: 500 error is displayed
Expected result: “Welcome screen” should have been displayed

5. Proof

Depending upon the nature of the bug add a log, screenshot, or video of the bug.

Tip: For the mobile apps, especially for the crashes, attach both system logs and crash log dumps, to help developers.

6. Severity/Priority

Mentioning the severity and priority helps project managers, product owners, and developers prioritize their work.
A bug can be a Blocker, Critical, Major, Minor, Trivial, or a suggestion.

For any kind of queries, suggestion and feedback please feel free to contact me on my email address nidasaleem333@gmail.com