Filing a bug

Owned by Medha Parlikar (Unlicensed)
Last updated: Jul 18, 2019 by Kelly Foster

If you are participating in community RNode testing, using the public testnet, the sandbox testnet or running your own node or network, you may run into a situation where you see a bug or have an experience that is inconsistent with what you expect.  Use the information on this page to file a bug so the development team has a record of your experience.

Guidelines:

If you are expecting the software to do something in a particular way and it doesn't, you should file an issue and let us know how the software failed to meet your expectations.  These are referred to a 'usability issues'.  These are a great form of feedback for the development team. Their value should not be underestimated.  

First check to see if the bug is already reported

Where to file an issue

If you don't see your bug listed on the dashboard, or are uncertain if a bug listed is the same, err on the side of caution and file a new bug.

  • Please go to https://rchain.atlassian.net
  • Either log in or create an account. If you choose not to do this, please do add your name and contact information to the ticket, so we can follow up if needed.

  • Select + to create a new issue 

What to include in the issue

  • Project = RCHAIN
  • Issue type = BUG
  • Summary = Brief statement of what the issue is. Hint: a cut/paste of the error message is helpful
  • Description:

Please include all of the following information in the description field.

  • What version of RNode were you running?
  • Steps to reproduce.  Include as much information as possible.  Such as:
    • System information (OS, hardware)
    • Network information (router config if you know it, router type, number of routers, etc..)
    • What you did.  Step by Step
  • Observations
    • What happened as you did each step?
    • What did you expect to happen?
    • Any logs from the system or contracts deployed. You can provide information via pastebin and share the link or save as a file and add as an attachment.
  • Questions or ideas
    • Based on the scenario and observations what questions do you have?
    • Based on the scenario and observations what ideas or recommendations do you have?

  • Priority: 
    • Highest → Blocks use of a feature
    • High → Feature very hard to use, difficult workaround
    • Medium → Feature hard to use, moderate workaround
    • Low → Feature is unpleasant to use, no workaround
    • Lowest → Feedback, no fix required.
  • Note: There are other fields on the ticket template. You do not need to add information to these fields.
  • Select Create when done.

  • Note: There are other fields on the ticket template. You do not need to add information to these fields.
  • Select Create when done.