Skip to content

Report a Bug

Adam Stankiewicz edited this page Dec 7, 2015 · 9 revisions

A good bug report shouldn't leave others needing to chase you up for more information.

Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What OS experiences the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

A bug report should include the following when submitting:

  • Informative Title
  • Steps to Reproduce
  • Expected Results
  • Actual Results
  • (optional) Attachments or Links - Helpful Additional Information

Required Components

Informative Title

It is best to avoid generic problems in the title

Some of examples of generic titles include:

  • XYZ is not working
  • Issue with XYZ
  • XYZ is corrupted

Being specific helps to get a quicker idea of what the issue is, how the bug can be searched against other possible bugs issues, and gives a clear understanding of the bug being reported.

Steps to Reproduce

Always number your steps and keep them short and to the point

This is the body of your report and the most important information needed for expressing what issues you have run into. Here are some tips when putting together the steps:

  • Use a prerequisite to reduce the number of steps - ex. 'When I run bower install'
  • Include every step that reproduces the issue. Try not to only include the last couple of steps, but all of those that led you to the bug
  • When possible, it would be great to share a short video - 2 minutes max - that shows the steps to reproduce

Expected and Actual Results

When describing expected results, explain what should happen, not what shouldn't happen

Once the steps have been included in the body of the report, please add what the expected results were and the actual results that you received.

Attachments

Attachments, or inline logs, can add a great deal of value to the report. Examples of attachments are screenshots, links to a video that shows the bug being reproduced, and lengthy log files.

Following the above when reporting a bug will increase the chances of the team reproducing the same issue and finding a way to resolve the issue.

Example Bug Report

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

Expected Description of the expected outcome

Actual Description of the actual outcome

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

You can’t perform that action at this time.