Bugs

Hero image for Bugs

Bug-free software does not exist. It is unrealistic to expect no bugs in an application. However, it is essential to properly document bugs when found so that the Engineering team can identify them and fix them quickly.

Four key pieces of information are required when reporting bugs:

  • Environment, to narrow down the conditions under which developers can reproduce the bug.
  • Prerequisites, to specify the scenario which leads up to the issue.
  • Steps to reproduce, to let the developers know how to see the bug occurring.

Bugs reported without steps to reproduce are extremely difficult to identify and fix. It will slow the Engineering team down considerably.

  • Expected outcome/behavior, to clarify what is considered the functioning feature.
  • Actual outcome/behavior, to detail when is happening but should not be happening.

Attachments

Product Managers and stakeholders are strongly encouraged to attach materials to help with the investigation work: screenshots, screencasts, references to similar or related issues, etc.

Bug Template

# Environment

- Platform: web/Android/iOS
- Device: e.g., iPhone 10
- OS: e.g., iOS 13
- Version: e.g., 0.12.0 (519)
- Environment: staging/production

# Prerequisites

Specify if there are specific conditions that must be met to recreate the issue. For example:

Use an account with no chat history / The app must be freshly launched / Launch the app from the already signed-in state with an account registered with mobile no.

# Steps to Reproduce

1. X
2. X
3. X

# Expected

Describe the expected outcome. Add screenshots if possible.

# Actual

Describe the actual behavior. Add screenshots and screencasts.