Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added images for guidance

If you are participating in community Node RNode testing, you may run into a situation where you see a bug , but you aren't quite sure.  This page will try to help clarify if you are seeing a real issue or notor 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.  

This page will strive to outline what a bug looks like, and where you should file it.

...

Where to file an issue

  • 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.

Image Added

  • Select + to create a new issue 

Image Added

What to include in the issue

  • Project = CORE
  • Issue type = BUG
  • Summary = Brief statement of what the issue is. Ex: 'Can't connect to network'

...

...

  • Description:
    • Symptom of the problem with a bit more detail
    • What you expected to happen
    • 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
      • What happened as you did each step
      • Any logs from the system (you can ask where the logs are on the system) 

Image Added

  • 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.

Image Added

Communications:

Here is a list of possible symptoms that are Communications communications issues

  • My node tells me it is connected, but I don't see any of the effects of being connected to the network.  
    • I don't receive blocks that have been proposed by other nodes
    • My list of peers isn't growing.
    • The server console isn't showing anything.
  • My node tells me it can't find the bootstrap node and exits

Consensus:

Here's some things that could go wrong:

...