• Reporting Bugs

    Send bug reports to support@AsylumResearch.com, but to help us resolve it quickly, please read on and learn how to compose a useful report for us to work from.

    Composing your Bug Report

    Effective bug reports are the most likely to be fixed. These guidelines explain how to write such reports.

    Principles

    • Be precise
    • Be clear - explain it so others can reproduce the bug
    • One bug per report
    • No bug is too trivial to report - small bugs may hide big bugs
    • Clearly separate fact from speculation

    Preliminaries

    1. Reproduce your bug using a recent build of the software, to see whether it has already been fixed.
    2. Look at the comments on the web page where you downloaded the latest build and see if the bug has been reported yet.

    Reporting a New Bug

    If you have reproduced the bug in a recent build and no-one else appears to have reported it, then try to included as many of these items in your bug report:

    Component: In which sub-part of the software does it exist?
    This field is required. Click the word "Component" to see a description of each component. If none seems appropriate, look for a "General" component.
    OS: On which operating system (OS) did you find it? (e.g. Linux, Windows XP, Mac OS X.)
    If you know the bug happens on more than one type of operating system, choose All. If your OS isn't listed, choose Other.

    Summary: How would you describe the bug, in approximately 60 or fewer characters?
    A good summary should quickly and uniquely identify a bug report. It should explain the problem, not your suggested solution.
    Examples:
    • Good Summary: "Cross section analysis tool hangs software"
    • Bad Summary: "Software crashes"
    • Bad Summary: "I could not make the software work"

    Description: The details of your problem report, including:
    Overview: More detailed restatement of summary.
    Overview Example:
    "When making a cross section of my data the debugger panel appears and the software gets stuck."
    Steps to Reproduce: Minimized, easy-to-follow steps that will trigger the bug. Include any special setup steps.
    Example:
    1) Open data in the date browser.
    2) Select the section tab in the data analysis panel
    3) Click on the Draw button
    4) Debugger panel hangs (see attached files for a screenshot).
    Actual Results: What the application did after performing the above steps.
    Example:
    The application crashed.
    Expected Results: What the application should have done, were the bug not present.
    Example:
    A cross section plot of my image.
    Build Date & Platform: Date and platform of the build in which you first encountered the bug. From within the AR SPM sofware, select from the main menu bar: Help > AR Versions, copy all the information and paste it into your bug report.
    AR Version 090909+0602
    MFP3D Xop Version 20092.28.103.103
    Argyle Xop Version 20092.3.2.8
    Utilities Xop Version 20092.1.13.1
    Video Xop Version 20083.2.7.1
    Mail Xop Version 1, 0, 0, 6
    Calculation Xop Version 20092.1.4.1
    Pixel Link Xop Version 20092.1.6.6
    Igor Version 6.1.2.1
    Additional Information: Any other useful information.

    • Screenshots
    • Attached files
    • Moon Phase
    Submitting your Bug Report
    Send bug reports to support@AsylumResearch.com.

    This text was adapted from https://landfill.bugzilla.org/bugzil...g-writing.html