Skip to content
This repository has been archived by the owner on May 16, 2019. It is now read-only.

Writing Bug Reports

Jump to bottom
ac225519 edited this page Feb 21, 2016 · 1 revision

##What To Include A good bug report must include the following four things:

  1. The steps to reproduce the bug: Give detailed steps on how to reproduce the problem.

    • Start from scratch
    • Explicitly mention every action involved, and how you invoked it (e.g., rather than “delete the text”, say “Select Cut from the context menu”)

  2. The expected behaviour of the application: It’s important to include the result you’re expecting, as it might differ from how the program was designed to work.

  3. The observed behaviour of the application: This is also important, since it’s possible that following your steps on a different system doesn’t reproduce the issue.

    • Include the data found in your debug.log file. You can find the log in the DATA_FOLDER defined in ob.cfg or just the OpenBazaar-Server folder on Linux platforms, and in %APPDATA\OpenBazzar\ on Windows. If you are using a developer installation, please also include the appropriate log data (i.e. Console) found in the "Developer Tools" windows.

Do not paste the log directly into the report. Post it somewhere else (e.g. Gist or Pastebin) and link to it.

  1. Information about your environment/platform

    • Include the operating system name/version
    • Include the version of OpenBazaar you are using. You can find a commit hash in the About OpenBazaar tab in the menu (or OpenBazaar-Client/.git/refs/heads/master if you use not a package).
    • If you are able to test multiple operating systems, do so
    • If your problem involves hardware, include information about that hardware
    • If your problem involves a server crash, provide a python backtrace from the OpenBazaar-Server console

Bug Report Template

When reporting bugs, you may choose to use the following template, either in its entirety, or with non-applicable sections left out.

Brief Description:

Operating System: Windows / OS X / Linux (include version and/or distro)
OpenBazzar version: (shown on `About OpenBazaar` page in menu)
Hardware: 
…

Reproducible: Always / Almost Always / Sometimes / Rarely / Couldn't Reproduce


Steps to reproduce:
1. 
2. 
3. 
…


Observed Behavior:


Expected Behavior:


Additional info:
(links, images, etc go here)

If your issue includes images, upload them to github. Don't use imgur, etc.

If you're using multiple embedded images, be sure to include a description for every image, preferably using the following format:

++++++++
+IMAGE1+
++++++++
↑ *Description of Image 1*

++++++++
+IMAGE2+
++++++++
↑ *Description of Image 2*

##Misc. Bug Reporting Tips

  1. Always include text in English. If your English is not very good, you may optionally include text in your native language, so that someone else may attempt to translate it more appropriately for you.

Reading Material

If you'd like to read other articles describing methods for writing bug reports, the following list contains a few very good picks:

Adapted from the guide in the qTox repository

Clone this wiki locally