Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Next »

(If you want to make a feature request, follow the instructions in How to Request a New Feature)

The ArchivesSpace team encourages all users of the ArchivesSpace application to report any bugs encountered during use of the application. 


Before reporting a bug

  • determine that the bug has not already been fixed by updating to the latest release and attempt to replicate the problem in it;
  • review the unresolved bugs logged in the ArchivesSpace development project to see if the bug has already been reported, in which case you can indicate in the existing report that you also encountered the bug instead of creating a new ticket; and, if desirable,
  • post a message to the ArchivesSpace Users Group list, asking for help in understanding and verifying the bug you encountered. To post to the list you will need to be staff of an ArchivesSpace member organization.


Once you have determined the bug has not been previously reported, login to your JIRA account, or sign up for one on JIRA. Then you can file the bug report, in one of two ways:

  1. Directly in JIRA (select Create issue; select ArchivesSpace New Workflow as the project)
  2. Indirectly via the “Send Feedback or Report a Problem” option appearing at the bottom of pages in the ArchivesSpace application in many installations. That link will bring you to the directions on this page. If that link is not there or not pointing to the current address, go directly to JIRA and select Create to create an issue, as in #1.

An actionable bug report requires the following:

  1. Issue Type identified as “Bug”
  2. Summary description of the problem encountered. It should be a short and specific title of the issue, for example:
      • Component order shifts after edit and save;
      • Wrap and tag editor does not work;
      • Resource title displays with escaped characters;

In the Description section, add the following sections:

  1. Steps to reproduce: describe the steps leading up to the problem. Keep each step simple, specific and unambiguous. Include relevant URLs and prefer using a noun to a pronoun.  Example:
    1. Edit a resource on Staff User Interface by browsing ''/staff/resources/<resource id>/edit"
    2. Mark an agent link as "primary" by clicking the respective "Make primary" button.
    3. Save the resource
    4. Click on Export → Download MARCXML
  2. Expected Results versus the Actual Results: explain what you expected to happen and what actually happened.

    Example:

    Expected result: ”An 1xx field should appear in the MARCXML export of the resource”

    Actual result: "No 1xx field appears in the in MARCXML export of the resource"

  3. Visual proof, screenshots, screencasts or other documents
    • It is helpful to take a screenshot or a screencast of the whole browser where the URL of the viewed page and all the relevant context is visible. Seeing just a button that has a wrong label does not help as it does not show where in the UI the button appears and in what context.
    • It is highly encouraged to include other relevant documents, such as an an excel file that causes an error while being imported.

  4. Assign a priority according to the severity of the issue.  The rankings range from the trivial (lowest) to blocker (most severe).
  5. Whenever possible, please assign relevant labels.  Example: accessibility, digital_objects, agents, etc.
  6. Affects Version/s is the version of the ArchivesSpace application in which the problem was encountered

Note: The other data fields will be used internally by the ArchivesSpace program team and can be disregarded.

Upon submission of the ticket, the program team will contact the submitter and all other commenters directly via the ticket.  

Ticket submitters are encouraged to remain vigilant of their ticket and respond to all responses from the program team in order for the issue to be addressed in a timely manner. 

  • No labels