Software, both proprietary and open source, has bugs, which tend to be surfaced as more and more users use the software.
...
(If you want to make a feature request, follow the instructions in How to Request a New Feature)
alsoThe ArchivesSpace team encourages all users of the ArchivesSpace application to report any bugs encountered during use of the application.
Note | |
---|---|
|
...
| |
Before reporting a bug |
...
|
...
|
...
|
...
|
...
|
Once you have
...
1) Directly to the ArchivesSpace Support Jira (select Create issue)
2) Indirectly via the “Report an Issue” on the ArchivesSpace website
3) Indirectly via the “Send Feedback” option appearing at bottom of pages in the ArchivesSpace application
All three pathways will load a form for reporting a bug:
...
determined the bug has not been previously reported
- Log in to your Jira account (You will need to create a JIRA account to submit a ticket)
- Access JIRA and select Create issue (Select ArchivesSpace New Workflow as the project).
An actionable bug report requires the following:
1) Project identified as “ArchivesSpace Support (AS)”
...
- Issue Type identified as “Bug”
...
Summary description of the problem encountered
...
4) that includes a brief statement of the problem, for example:
- Component order shifts after edit and save;
- Wrap and tag editor does not work;
- Resource title displays with escaped characters;
...
. It should be a short and specific title of the issue. (Example: Wrap and tag editor does not work)
A detailed description of the issue. This includes:
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.
Info icon false Include relevant URLs or relative paths
For example instead of formulating a step as: Navigate to the top containers configuration, prefer including the URL or the relative path (the url without the domain name part) as it appears in the address bar of your web browser: Navigate to the top containers configuration: "/staff/top_containers"
Info icon false Prefer using nouns to pronouns
For example instead of: It does not include the resource ids a step could be less ambiguous as: The EAD export does not include the resource idsInfo icon false Complete Example:
Edit a resource on Staff User Interface by browsing ''/staff/resources/<resource id>/edit"
Mark an agent link as "primary" by clicking the respective "Make primary" button.
Save the resource
Click on Export → Download MARCXMLExpected Results versus the Actual Results: explain what you expected to happen and what actually happened.
Info icon false 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"Visual proof, screenshots, screencasts or other documents
Info icon false Note:
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.
- Assign a priority according to the severity of the issue. The rankings range from the trivial (lowest) to blocker (most severe).
- Whenever possible, please assign relevant labels. Example: accessibility, digital_objects, agents, etc.
- Indicated the affected version. Affected version/s is the version of the ArchivesSpace application in which the problem was encountered
...
6) Email address of the reporter recorded in a comment area (for the purpose of following up if necessary)
Optional information may be recorded as follows:
1) A fuller description of the event, describing the steps leading up to when 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.