Documentation/4.6/Report a problem - Revision history

Inorton: /* User Feedback */

2017-06-08T13:38:34Z

User Feedback

Inorton: /* User Feedback */

2017-06-08T13:28:28Z

User Feedback

UpdateBot: Nightly -> 4.6

2016-11-07T07:54:49Z

Nightly -> 4.6

New page

=User Feedback=

*I have a question about how to use Slicer for a particular task or I'm not sure things are working right
** Try your best to sort out the issue by reading documentation, mailing list archives, and checking error logs
*** Look at our [[Documentation/UserTraining|portfolio of training materials]] and make a google search to see, if the question has been discussed in the mailinglists.
*** I am still unclear about what to do. In this case, [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-users sign up] for the slicer user mailing list and ask your question there
*** Check the [[Documentation/{{documentation/version}}/SlicerApplication/ErrorLog#To_capture_the_entire_error_log_for_a_report|Error Log]] to see if there's something misconfigured, such as a directory that is not readable or writable.
*Something is definitely not working as it should or I would like to request a feature.
** File a bug report in the issues [http://na-mic.org/Mantis/bug_report_page.php tracker] (you need to register first) or on the [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-users Slicer users mailing list]. It is important to provide enough specific information so that a software developer can duplicate the problem - [[Documentation/{{documentation/version}}/Report_a_problem#Error_report_contents|see details below]].
** Don't be anonymous: real people trying hard to solve real problems are more likely to get valuable help. A vague question from a random email is likely to be ignored..
* I would like to let the Slicer community know, how Slicer helped me in my research.
**Please send us the citation for your paper.
**Background: funding for Slicer is provided through competitive mechanisms to a large extent by the US government and to a lesser extend through funding from other governments. The justification of for those resources is that Slicer enables scientific work. Knowing about scientific publications enabled by Slicer is a critical step in this process. Given the international nature of the Slicer community, the nationality of the scientists is not important. Every good paper counts.
* I would like to give feedback on my experience with Slicer.
**Share your story using the Feedback link accessible from the Slicer Welcome module

==Error report contents==
* Describe:
** What steps were performed before the problem occurred
** What behavior you expected
** What happened instead
* Copy-paste the error log: you can access it from Slicer in the menu: Help / Report a bug. By default log of the current session is displayed but you can retrieve the logs of the last few sessions
* Optional: capture a screenshot that illustrates the issue

That could be summarized by the SSCCE (Short, Self Contained, Correct (Compilable), Example) approach documented on http://sscce.org

==Workflow for Handling Bugs and Feature Requests in Slicer==

The following instructions describes the recommended workflow to report a problem related to Slicer application.

* 1. [http://na-mic.org/Mantis/signup_page.php Register] on the issue tracker

* 2. [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the developers mailing list

* 3. Create an issue in the [http://na-mic.org/Mantis/bug_report_page.php tracker].

* 4. Optionally, if you would like to share dataset >= 2MB, you should consider uploading them on our dedicated server. See [[Documentation/{{documentation/version}}/Report_a_problem/UploadData|How to share and associate data with an issue]]

* 5. Send an email on the [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel slicer-developers] list pointing to the reported bug. Title of the email should start with <code>[BUG 1234] Title of the bug</code>

{{:Documentation/{{documentation/version}}/Developers/IssueWorkflow}}

@@ Line 12: / Line 12: @@
 *** <big>[https://discourse.slicer.org Ask a question on the Slicer Forum!]</big>
 *Something is definitely not working as it should or I would like to request a feature.
-** File a bug report in the issues [http://na-mic.org/Mantis/bug_report_page.php tracker] (you need to register first) or on the [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-users Slicer users mailing list]. It is important to provide enough specific information so that a software developer can duplicate the problem - [[Documentation/{{documentation/version}}/Report_a_problem#Error_report_contents|see details below]].
+** File a bug report in the issues [http://na-mic.org/Mantis/bug_report_page.php tracker] (you need to register first). It is important to provide enough specific information so that a software developer can duplicate the problem - [[Documentation/{{documentation/version}}/Report_a_problem#Error_report_contents|see details below]].
 ** Don't be anonymous: real people trying hard to solve real problems are more likely to get valuable help.  A vague question from a random email is likely to be ignored..
 * I would like to let the Slicer community know, how Slicer helped me in my research.

@@ Line 6: / Line 6: @@
 *I have a question about how to use Slicer for a particular task or I'm not sure things are working right
-** Try your best to sort out the issue by reading documentation, mailing list archives, and checking error logs
+** Try your best to sort out the issue by reading documentation and checking error logs
-*** Look at our [[Documentation/UserTraining|portfolio of training materials]] and make a google search to see, if the question has been discussed in the mailinglists.
+*** Look at our [[Documentation/UserTraining|portfolio of training materials]] and make a google search to see if the question has been discussed.
 *** Check the [[Documentation/{{documentation/version}}/SlicerApplication/ErrorLog#To_capture_the_entire_error_log_for_a_report|Error Log]] to see if there's something misconfigured, such as a directory that is not readable or writable.
 *Something is definitely not working as it should or I would like to request a feature.
 ** File a bug report in the issues [http://na-mic.org/Mantis/bug_report_page.php tracker] (you need to register first) or on the [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-users Slicer users mailing list]. It is important to provide enough specific information so that a software developer can duplicate the problem - [[Documentation/{{documentation/version}}/Report_a_problem#Error_report_contents|see details below]].