How to Report Bugs the Smart Way [closed]

Question

I want to write (or find) a guide to effective bug reporting in a style similar to ESR's How To Ask Questions The Smart Way

What are your top tips for effective bug reports?

Answer 1

• Step-by-step instructions on how to recreate the bug
• Make sure you've attempted to isolate the bug to what you are actually writing a bug against, instead of something else that could be the cause.
• List attempts to isolate the bug to something other than the software you are writing a bug against
• Make yourself available to answer questions and be available to help troubleshoot/recreate the bug

The bottom line is you have to engage some level of critical thinking when the bug is encountered. Once you've exhausted all possibilities that it could be your fault, write up a bug. If you find out its your fault, but the software you are using/testing could have done something more usable to indicate its your fault, still write a bug.

Also, to be a truly great bug-reporter, you must avail yourself to those testing the bug to help them recreate it. Its likely you've just "got the knack" for recreating that bug and there may be steps you are not conscious of. You can't just complain and walk away, participate in the process and help the team out by testing, recreating, and troubleshooting.

Answer 2

Report the observable facts and then your interpretation of those facts.

Sometimes the best bug reports include something that is a gut feel of an understanding of the problem. Facts-only bug reporting discounts this valuable human resource.