Difference between revisions of "Documentation/Nightly/Report a problem"
From Slicer Wiki
Tag: 2017 source edit |
|||
| Line 2: | Line 2: | ||
<noinclude>{{documentation/versioncheck}}</noinclude> | <noinclude>{{documentation/versioncheck}}</noinclude> | ||
--> | --> | ||
| − | |||
=User Feedback= | =User Feedback= | ||
*I have a question about how to use Slicer for a particular task or I'm not sure things are working right | *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 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. | + | ***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. | + | ***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. |
| − | ** I am still unclear about what to do. | + | **I am still unclear about what to do. |
| − | *** <big>[https://discourse.slicer.org Ask a question on the Slicer Forum!]</big> | + | ***<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. | *Something is definitely not working as it should or I would like to request a feature. | ||
| − | ** File a bug report in the issues [http:// | + | **File a bug report in the issues [http://issues.slicer.org/ 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.. | + | **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. | ||
**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. | **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. | + | *I would like to give feedback on my experience with Slicer. |
**Share your story using the Feedback link accessible from the Slicer Welcome module | **Share your story using the Feedback link accessible from the Slicer Welcome module | ||
==Error report contents== | ==Error report contents== | ||
| − | * Describe: | + | |
| − | ** What steps were performed before the problem occurred | + | *Describe: |
| − | ** What behavior you expected | + | **What steps were performed before the problem occurred |
| − | ** What happened instead | + | **What behavior you expected |
| − | * 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 | + | **What happened instead |
| − | * Optional: capture a screenshot that illustrates the issue | + | *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 | That could be summarized by the SSCCE (Short, Self Contained, Correct (Compilable), Example) approach documented on http://sscce.org | ||
| Line 34: | Line 34: | ||
The following instructions describes the recommended workflow to report a problem related to the Slicer application. | The following instructions describes the recommended workflow to report a problem related to the Slicer application. | ||
| − | * 1. [https://issues.slicer.org/signup_page.php Register] on the issue tracker | + | *1. [https://issues.slicer.org/signup_page.php Register] on the issue tracker |
| − | * 2. [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the [https://discourse.slicer.org/ Discussion Forum] | + | *2. [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the [https://discourse.slicer.org/ Discussion Forum] |
| − | * 3. Create an issue in the [https://issues.slicer.org/bug_report_page.php issue tracker]. | + | *3. Create an issue in the [https://issues.slicer.org/bug_report_page.php issue 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]] | + | *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. Post on the [https://discourse.slicer.org/new-topic?body=Operating%20system:%0ASlicer%20version:%0AExpected%20behavior:%0AActual%20behavior:&category=support Discussion Forum] pointing to the reported bug. Title of the post should start with <code>Issue 1234: Title of the issue report</code> | + | *5. Post on the [https://discourse.slicer.org/new-topic?body=Operating%20system:%0ASlicer%20version:%0AExpected%20behavior:%0AActual%20behavior:&category=support Discussion Forum] pointing to the reported bug. Title of the post should start with <code>Issue 1234: Title of the issue report</code> |
{{:Documentation/{{documentation/version}}/Developers/IssueWorkflow}} | {{:Documentation/{{documentation/version}}/Developers/IssueWorkflow}} | ||
Revision as of 14:56, 7 April 2020
Home < Documentation < Nightly < Report a problemUser 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 and checking error logs
- Look at our portfolio of training materials and make a google search to see if the question has been discussed.
- Check the Error Log to see if there's something misconfigured, such as a directory that is not readable or writable.
- I am still unclear about what to do.
- Try your best to sort out the issue by reading documentation and checking error logs
- Something is definitely 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 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 the Slicer application.
- 1. Register on the issue tracker
- 2. Sign-up on the Discussion Forum
- 3. Create an issue in the issue tracker.
- 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. Post on the Discussion Forum pointing to the reported bug. Title of the post should start with
Issue 1234: Title of the issue report
The following diagram illustrates Slicer issue workflow:
Source: Adapted from http://www.warelab.org/blog/?p=24
