Skip to main content

Recording and Reporting Bugs

Properly documenting and reporting bugs is important to make sure issues are found, tracked, and fixed efficiently.

Best Practices for Reporting Bugs​

  • Clear Description: Give a brief but clear explanation of the bug, including what went wrong and what should have happened instead.
  • Steps to Reproduce: Provide step-by-step instructions on how to recreate the issue so developers can understand and resolve it.
  • Include information like the device model, OS version, network conditions, and app version to identify when and where the bug occurs.
  • Screenshots/Videos: Attach screenshots or videos to show the issue, especially for UI-related bugs visually.
  • Severity and Priority: Indicate how serious the bug is and how urgently it needs to be fixed.
  • Logs: If available, include log files to help developers debug the issue more easily.

Bug Report Example​

Build Version: 1.0.3

Device manufacturer and model number: Samsung Galaxy S10

Device OS and version: Android 11

Is the Issue device Specific: Yes

Defect Type (Exploratory/Regression): Exploratory

Reproducibility: 100%

Pre-conditions:

  • The app is installed and opened on the device.
  • The user is logged into the app.

Steps to reproduce:

  • Navigate to the home screen.
  • Tap on the "Submit" button in the feedback form. Actual result: Nothing happens when tapping the "Submit" button.

Expected result: The feedback form should be submitted, and a confirmation message should appear.

Attachments: phone_log.txt, videofrombug.mp4

More can be found HERE.