Difference between revisions of "Documentation/SlicerRT/HowToReportAnError"

From Slicer Wiki
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
===Reproduce reliably with latest version===
 
===Reproduce reliably with latest version===
* Make sure you use the latest Slicer and SlicerRT.
+
# Make sure you use the latest Slicer and SlicerRT.
* Try to reproduce the error and filter out what steps are really required for the error to occur
+
# Try to reproduce the error and filter out what steps are really required for the error to occur
  
 
===Provide relevant information about the issue (send us email)===
 
===Provide relevant information about the issue (send us email)===
# Describe exactly what steps you made before the error occured
+
# Describe '''exactly what steps''' you made before the error occured
 
# What happens exactly that is the unexpected behavior
 
# What happens exactly that is the unexpected behavior
 
# Read the entries in the Error Log window, and send us the ones that seem to be related to SlicerRT
 
# Read the entries in the Error Log window, and send us the ones that seem to be related to SlicerRT
Line 15: Line 15:
 
#* Otherwise, report the used Slicer and SlicerRT versions (stable/nightly, which version/day)
 
#* Otherwise, report the used Slicer and SlicerRT versions (stable/nightly, which version/day)
  
===Report issue in system (if it proves to be something to fix on our side)===
+
===Report issue in system (once confirmed it is something to fix on our side)===
# If you are not a member of the SlicerRT project, join the space
+
# Add issue to [https://github.com/SlicerRt/SlicerRT/issues Github SlicerRT project]
#* If you do not have an Assembla user, you will have to create one as well
+
#* Assign to no milestone
# Create a ticket (assign to no milestone)
 
 
#* Add all information from the above section to the ticket description
 
#* Add all information from the above section to the ticket description
  
 
<br>
 
<br>
 
Thank you for helping to improve SlicerRT!
 
Thank you for helping to improve SlicerRT!

Latest revision as of 14:12, 18 June 2018

Home < Documentation < SlicerRT < HowToReportAnError

If you encounter an error, please follow the following instructions to help us to find and fix it more quickly.

Reproduce reliably with latest version

  1. Make sure you use the latest Slicer and SlicerRT.
  2. Try to reproduce the error and filter out what steps are really required for the error to occur

Provide relevant information about the issue (send us email)

  1. Describe exactly what steps you made before the error occured
  2. What happens exactly that is the unexpected behavior
  3. Read the entries in the Error Log window, and send us the ones that seem to be related to SlicerRT
  4. Send us the contents of the Python Interactor window
  5. If needed for easier understanding, attach a screenshot
    • Use compressed format (like .png, .jpg, .gif)
  6. If you have built your version yourself (you don't use the package), add the SVN revision number (also the Slicer revision number)
    • Otherwise, report the used Slicer and SlicerRT versions (stable/nightly, which version/day)

Report issue in system (once confirmed it is something to fix on our side)

  1. Add issue to Github SlicerRT project
    • Assign to no milestone
    • Add all information from the above section to the ticket description


Thank you for helping to improve SlicerRT!