Skip to content

Writing a Bug Report - Best Practices

A good bug report answers

  • What happened?
  • What should have happened?
  • How can we reproduce it?
  • How severe is it?
  • Title: short and specific
  • Environment: OS, browser/app version
  • Steps to reproduce: numbered steps
  • Expected result
  • Actual result
  • Evidence: screenshots/logs/videos
  • Impact: users affected, frequency

Example

Title: Checkout fails when coupon contains spaces

Steps:

  1. Add item to cart
  2. Open checkout
  3. Enter coupon SAVE 10SAVE 10
  4. Click Apply

Expected: Discount applied

Actual: 500 error

Tip

If you can include:

  • HAR file
  • request/response sample

…it speeds up debugging.

If this helped you, consider buying me a coffee β˜•

Buy me a coffee

Was this page helpful?

Let us know how we did