[README] [HOW TO REPORT A BUG/ERROR] A bug in the program? Please help and report it this way...

[Rachid]

Dear CLARK users,

First of all, please make sure to run CLARK according to its instructions provided in the README file, including technical requirements (memory and system). Several examples and explanations of the options are provided to show how to execute

the program.

Second, if you do encounter a program issue or error when running CLARK then please feel free to report it so we can fix it and release a stronger/more stable version!

Here are directions to allow us to proceed as quickly as possible (Extract from the CLARK website):
• Rerun CLARK (or the related variant) with all conditions that created the bug to make sure the bug is reproducible.

• Check whether or not, the bug is persistent with other sample files (e.g., the publicly available datasets we used in our peer-reviewed papers) or only specific to your input data.  

• If the bug is reproducible, then please send an email to clark.ucr.help at gmail.com or create a post in this forum, with :

1) Your contact information (i.e., at least your FULL name and an email address) so we contact you as soon as the fix is available or if we need more information.

2) Information about your input data (database and datasets) that created the bug/error if the bug is not persistent with other samples. If you've used non-public data then create a folder containing these data, zip it and share it with us. This is necessary to reproduce the bug in our side and identify quickly the failure unless the bug occurs independently of the input data (in the latter case, no need to send us your data but do indicate that the bug is not data input-specific). If you share with us your data be aware that we will not share, distribute, or duplicate them without your expressed and written permission and these data will be destroyed as soon as the bug fix is completed and released. You may also upload your data in a platform (such as Dropbox) and share with us the link to access them. 

3) All parameters or the full command line used when the bug occurred (including the variant, CLARK, CLARK-l, or CLARK-S) and the logs.

4) The platform information on which you run CLARK and the version of CLARK ("uname --all" command). 

If your bug/error report fails to detail/include all of these information then we do not guarantee a rapid analysis and response to your issue.

Please remember that CLARK is being supported so make sure your report is as complete as possible. 

If not enough information is provided on a reported bug, error or malfunction then the related post will be automatically set as "completed" or "close" after 3 weeks of inactivity.

Best,

Rachid