Writing a Bug Report - Best Practices
A good bug report answers
Section titled “A good bug report answers”- What happened?
- What should have happened?
- How can we reproduce it?
- How severe is it?
Recommended template
Section titled “Recommended template”- 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
Section titled “Example”Title: Checkout fails when coupon contains spaces
Steps:
- Add item to cart
- Open checkout
- Enter coupon
SAVE 10 - Click Apply
Expected: Discount applied
Actual: 500 error
If you can include:
- HAR file
- request/response sample
…it speeds up debugging.
pch.coffeeTagline
pch.coffeeCtapch.feedbackHeading
pch.feedbackSubheading