QuNex Issue Reporting Guide

Issues
1

To maintain an effective issue resolving workflow and make sure your problems will be solved in a timely manner we prepared simple guide. Before creating an issue, please do the following:

  • Check the QuNex Documentation to make sure the behavior you are reporting is really a bug, not a feature.
  • Check the existing issues in the QuNex Forum to make sure you are not duplicating somebody’s work.

If what you are about to report is in indeed an issue and is not already being discussed on this forum then create a new post. When creating a new post please use a descriptive title, do not use ambiguous titles such as “A QuNex bug”. This will allow other users with similar issues to find help in an efficient manner. The post itself should contain as much relevant information as possible. Use the list below to make sure you provide everything we need for replication and resolution of your issue:

If we do not have access to your file system, please use the Description Call Logs (DCL) convention:

  • Description: a detailed description of the issue and the workflow/analysis during which the issue was encountered.
  • Call: the exact and explicit QuNex command call you used. To allows us to replicate and resolve the problem you need to provide all elements of the code (the batch.txt file, call parameters …). If several commands were ran in a sequence also provide calls to prior commands.
  • Logs and outputs: all logs (runlogs and comlogs found in the processing/logs folder) and outputs (stdout and stderr) associated with the execution of the command.

If we do have access to your file system, please use the Description Call Path (DC) convention:

  • Description: a detailed description of the issue and the workflow/analysis during which the issue was encountered.
  • Call: the exact and explicit QuNex command call you used. To allows us to replicate and resolve the problem you need to provide all elements of the code (the batch.txt file, call parameters …). If several commands were ran in a sequence also provide calls to prior commands.
  • Path: exact and absolute paths for the code used in the call, the data used in the call, and any logs/outputs that may be been produced. Please ensure that we have access to these directories on your file system, so we are able to replicate and resolve the error.

** For an example of how to report an issue, please refer to this post. More information and examples on how to report issues are also provided on the QuNex Wiki here.