Create a gist now

Instantly share code, notes, and snippets.

@irms /bug-report.rst
Last active Nov 11, 2015

What would you like to do?
The right way to file a bug report

Bug reports and issue tracker

Please follow these guidelines when creating new tickets for Buildicus. Issues can be reported on the Github issue tracker.

Writing a useful bug report

Useful bug reports are ones that get bugs fixed. A useful bug report normally has two qualities:

  1. Reproducible. If your bug is not reproducible it will never get fixed. You should clearly mention the steps to reproduce the bug. Do not assume or skip any reproducing step. Described the issue, step-by-step, so that it is easy to reproduce and fix.
  2. Specific. Do not write an essay about the problem. Be Specific and to the point. Try to summarize the problem in a few words and use screenshots extensively. Do not combine multiple problems even if they seem to be similar. Write different reports for each problem.

Example

A good bug report looks something like this:

OS: Operating System and version (Windows 7, OS X 10.8, Ubuntu 13.04)
Browser: Browser name and version (IE 10, Firefox 27, Google Chrome 30)

Steps to Reproduce

1. Step-by-step instructions that detail how to reproduce the bug
2. Don't leave steps out or make any assumptions
3. If screenshots are called for, provide them here
4. Make sure these steps reliably reproduce the issue

Actual Result

Describe what happens when the above steps were followed. If there is any
relevent information in the developer tools window, make note of it here.

Expected Result

Explain what should have happened -- or what you expected to happen -- when
the above steps were followed.

Workaround

If you have know a way to work around the problem, describe it here.

Here's a template you can paste directly into Github:

**OS**:

**Browser**:

**Summary**

**Steps to Reproduce**

**Actual Result**

**Expected Result**

**Workaround**
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment