x First time here? Check out the FAQ

Come work for Umbraco - The Umbraco HQ are hiring Project managers, .NET developers and DevOps people!

How to write a useful Bug Report

     

    What makes a good bug report?

    A good bug report will make or break issue response time. Here's a few good tips on what makes an awesome bug report:

    1. Steps to reproduce

    Include a walk through of what you were doing, for example: 
    1. logged into Back Office
    2. navigated to content
    3. right clicked on content node 
    4. the context menu failed to appear


    2. Environment information

    The more we know about your setup the more we can make one which mirrors it to reproduce the problem, try to include:

    • Umbraco version (are you running 4.0, 4.5, etc). If you're using nightly builds, make sure to include the build number as well.
    • Any Umbraco Packages installed
    • Browser version (ie: FireFox 3.6.1)
    • Any browser plugins
    • OS version
    • Environment (local machine, production, etc)
    • Website configuration (are you running Cassini, IIS Express or IIS?)
    • What database environment did you use? SQL, MySQL, SQL CE?
    • Any logs pertaining to the issue (umbracoLog table, or for v5 information from the ~/App_Data/Logs/UmbracoTraceLog.txt file)

    3. Can you reproduce it?

    • Did you try different browsers?
    • Did you try different machines? 
    Let us know what you tried as it can help knock out scenarios that don't produce the error.


    4. Listing expectations

    So you've found a bug, but what were you expecting to happen? This is more relevant when you didn't receive an error message, but had something happen, only it wasn't what you thought was going to happen. If this is the case be sure to include what you expected to happen, and provide as much relevant detail as possible.