Skip to content

Bug Reporting Guideline

Johny Georges edited this page Dec 9, 2017 · 5 revisions

How to write a bug report

When it comes to reporting a bug, it's very important that you provide the information needed so that the developer will be able to reproduce the bug.

Every bug report will need to provide the following information, so please make sure that you have this information available before you open an issue for a bug.

  • Description - what is the bug about and who does it affect?
  • How to Reproduce - what are the steps needed to reproduce the bug?
  • Actual Result - what happens when this bug occurs?
  • Expected Result - what did we expect to happen?
  • Additional Information (Optional) - you can also provide additional information if you think it will help with the reproduction of the bug.
    • System Information
      • Operating System
      • NodeJS and NPM versions (if applicable)
    • Browser and its version
    • Screenshot

Just a few more things to keep in mind:

  • If you know a fix/workaround for the bug, please mention it in the bug report.
  • If you are unable to consistently reproduce the bug scenario, please make a note of it in the bug report so that we can prioritize the bug fix accordingly.
  • Please double check and make sure that the bug you are trying to report has not been reported already. You can check by going through the issues list and scanning the ones that are tagged with bug

Happy Bug Hunting!