How to Write a Good Bug Report: A Comprehensive Guide

1. Clear Summary:

•  Summarize the bug clearly.
•  The summary should give the bug's full picture in a single sentence.

2. One Issue = One Bug:

•  Do not combine multiple issues in one bug.
•  Because different bugs can be assigned to different developers to fix.

3. Clear & Detailed Description:

•  Expand the summary in description-simple and precise.
•  Provide as much information as possible.

4. Steps To Reproduce:

•  How can you reproduce the bug - mention it in bullet points.
•  Clear enough developers would reproduce and fix quickly.

5. Expected & Actual Results:

•  What is the requirement & what is happening?
•  The developer knows what is the issue by looking at it.

6. Additional Details As Notes:

•  Write about your additional observations.
•  Helps developers to analyze & hence fix bugs quickly.

7. Environment Details:

•  Where have you tested - QA/PRD/CHROME ETC.
•  Developer compares this with other environments.

8. Build Number:

•  In which version of the application you found the bug.

9. PRIORITY:

•  How soon the bug should be fixed.
•  Can be HIGH/LOIW/MEDIUM.

10. SEVERITY:

•  Impact on the product.
•  Can be CRITICAL/MAJOR/MINOR/TRIVIAL.

11. Screenshot/Screen Recording:

•  Evidence of the bug.
•  Can be screenshots or screen recordings.

12. Link the related test case and or story:

•  Link bug to story/test case you are testing.
•  Can be 'Associated With' OR 'Blocked By'.

13. LOGS:

•  Attach log file or snippet of log.
•  This is a mine of data for developers.

14. Avoid Duplicates:

•  Check if already bug is reported by someone.