Difference between revisions of "Documentation/4.4/Report a problem"
From Slicer Wiki
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
=User Feedback= | =User Feedback= | ||
| − | *I have a question about how to use Slicer for a particular task | + | *I have a question about how to use Slicer for a particular task or I'm not sure things are working right |
| − | ** 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. | + | ** Try your best to sort out the issue by reading documentation, mailing list archives, and checking error logs |
| − | ** I am still unclear about what to do. In this case, sign up for the slicer user mailing list: [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-user Sign-up] | + | *** 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, sign up for the slicer user mailing list: [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-user Sign-up] | ||
| + | *** 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 not working as it should or I would like to request a feature. | *Something is 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). It is important to provide enough specific information so that a software developer can duplicate the problem. [[Documentation/{{documentation/version}}/Report_a_problem#Workflow_for_Handling_Bugs_and_Feature_Requests_in_Slicer|See below]] for more details. | ** 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#Workflow_for_Handling_Bugs_and_Feature_Requests_in_Slicer|See below]] for more details. | ||
** Be sure to check the [[Documentation/{{documentation/version}}/SlicerApplication/ErrorLog#To_capture_the_entire_error_log_for_a_report|Error Log]] and include any related information in your report. | ** Be sure to check the [[Documentation/{{documentation/version}}/SlicerApplication/ErrorLog#To_capture_the_entire_error_log_for_a_report|Error Log]] and include any related information in your report. | ||
| + | ** 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. | * I would like to let the Slicer community know, how Slicer helped me in my research. | ||
**Please send us the citation for your paper. | **Please send us the citation for your paper. | ||
Latest revision as of 13:32, 20 February 2015
Home < Documentation < 4.4 < Report a problem
|
For the latest Slicer documentation, visit the read-the-docs. |
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 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, sign up for the slicer user mailing list: Sign-up
- Check the Error Log to see if there's something misconfigured, such as a directory that is not readable or writable.
- Try your best to sort out the issue by reading documentation, mailing list archives, and checking error logs
- Something is not working as it should or I would like to request a feature.
- File a bug report in the issues tracker (you need to register first). It is important to provide enough specific information so that a software developer can duplicate the problem. See below for more details.
- Be sure to check the Error Log and include any related information in your report.
- 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
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. Register on the issue tracker
- 2. Sign-up on the developers mailing list
- 4. Optionally, if you would like to share dataset >= 2MB, you should consider uploading them on our dedicated server. See How to share and associate data with an issue
- 5. Send an email on the slicer-developers list pointing to the reported bug. Title of the email should start with
[BUG 1234] Title of the bug
The following diagram illustrates Slicer issue workflow:
Source: Adapted from http://www.warelab.org/blog/?p=24
