Writing Good Bug Reports

Posted on November 26, 2012

A good bug report can save valuable time in any organization. Even seasoned devs and testers need to be reminded of this every now and then. Here are examples of good and bad bug reports of the same bug:

Good Bug Report


Title:

Broadcast window fails to dismiss on delivery success

Environment:

Windows 7 IE9 on Production build 7a0a82436d64d71e72c665db8dd07c6fb9b91511

Steps to reproduce:

  1. Load the app using a non-privileged user (example: testuser123).
  2. Click 'broadcast' on a roster in the roster area.
  3. Enter a message in the window.
  4. Click 'Send'.

Expected:

Message sends, confirmation is displayed, and window closes itself.

Actual:

Message sends, confirmation is displayed. Window stays open and cannot be dismissed. User is forced to reload the page.

Screenshot:

[some useful screenshot of the issue]

Extras:

I also noticed these errors in the Javascript console:

http://www.awesome.com/javascripts/hey_hey_hey_hey_you.js:383\n\nUncaught TypeError: Cannot call method 'chickenNoodle' of null

Bad Bug Report


Title:

Broadcast freezes app

Description:

When I hit broadcast the app freezes.



<3, devs everywhere

comments powered by Disqus