Difference between revisions of "Resources/Issue tracker"

Latest revision as of 07:42, 3 July 2025

Main Page > Resources > Resources/Issue tracker

Artefactual uses GitHub to track bugs and issues in AtoM.

Important

Artefactual no longer uses Redmine for issue tracking. This has been deprecated. If you are looking for an issue from Redmine and cannot find it in GitHub, please contact contributors@artefactual.com.

We're currently in the process of cleaning up legacy issues from our issue list, but as we progress with this work, this is what you can expect to see:

An issue can refer to a feature, a bug, or a task. Features are enhancements or new functionality that did not previously exist. Bugs are reports of existing functionality that does not work as expected, or problems with the application.
Issues are given tags. If the issue is is a bug it will generally be tagged with Type: Bug and if it is a feature or enhancement it will be tagged with Type: enhancement.
An issue is given a milestone (e.g. Release 2.11) only if we are certain it will be included in an upcoming release. Bugs that are reported but not sponsored for development or fixed by Artefactual or a community contributor will be left without a milestone until they have been addressed, and can be associated with a specific release. See all milestones here.
Bug reports should be given a Tested version in the issue, so that we know which version of the application was used to reproduce the issue, and we can assess if a bug remains relevant to future releases over time.

Important

You can find out how to submit an issue in our contributing guide.

@@ Line 1: / Line 1: @@
-[[Main Page]] > [[Resources]] > [[Resources/Issue tracker]]
+{{#pagetitle: Issue tracker }}
+[[Main Page]] > [[Resources]] > Resources/Issue tracker
-Artefactual uses [http://www.redmine.org/ Redmine] project management software to track bugs and issues in AtoM. You can find our Redmine instance at https://projects.artefactual.com
-= Register for an account =
+Artefactual uses [https://github.com/artefactual/atom/issues GitHub] to track bugs and issues in AtoM.
-You can register for an account in Redmine at: https://projects.artefactual.com/account/register
+<admonition type="Important">
+Artefactual no longer uses [https://projects.artefactual.com Redmine] for issue tracking. This has been deprecated. If you are looking for an issue from Redmine and cannot find it in GitHub, please contact [mailto:contributors@artefactual.com contributors@artefactual.com].
+</admonition>
-If you are a client of Artefactual, you likely already have an account. Email support@artefactual.com if you need assistance.
-= Search for a bug or issue =
+We're currently in the process of cleaning up legacy issues from our issue list, but as we progress with this work, this is what you can expect to see:
-Anyone can search Redmine for an existing issue or bug. Visit https://projects.artefactual.com and enter your search keywords.
+* An issue can refer to a ''feature'', a ''bug'', or a ''task''. Features are enhancements or new functionality that did not previously exist. Bugs are reports of existing functionality that does not work as expected, or problems with the application.
+* Issues are given tags. If the issue is is a bug it will generally be tagged with '''Type: Bug''' and if it is a feature or enhancement it will be tagged with '''Type: enhancement'''.
+* An issue is given a '''milestone''' (e.g. Release 2.11) '''only''' if we are certain it will be included in an upcoming release. Bugs that are reported but not sponsored for development or fixed by Artefactual or a community contributor will be left without a milestone until they have been addressed, and can be associated with a specific release. See all milestones [https://github.com/artefactual/atom/milestones here].
+* Bug reports should be given a '''Tested version''' in the issue, so that we know which version of the application was used to reproduce the issue, and we can assess if a bug remains relevant to future releases over time.
-You can also browse AtoM issues here: https://projects.artefactual.com/projects/atom/issues
-Note that issues or bugs related to client-specific development will not appear if you are not logged in, and further if your account is not associated with that project.
+<admonition type="Important">
+You can find out how to submit an issue in our [https://github.com/artefactual/atom/blob/qa/2.x/CONTRIBUTING.md contributing guide].
+</admonition>
-= Create a new bug or issue =
-. Always search Redmine for an existing bug or issue before reporting a new one.
+-----
-. To create a new bug or issue, navigate to the AtoM project by clicking on "Jump to a project" and then "AtoM".
+* [[Resources|Back to Resources]]
+* [[Main Page|AtoM wiki home]]
-. Click on "New Issue" and fill in the required fields as outlined below:
-==Tracker==
-Choose "Bug" for an issue with an existing feature, or "Feature" to suggest a new functionality to AtoM.
-==Subject==
-Provide a brief description of the bug or feature you are requesting.
-==Description==
-Helpful information to include in the Description field are the steps to reproduce the bug or behaviour you are experiencing. For us to be able to best diagnose any bug reported, other developers will need to be able to reproduce it. Our preferred method for bug reporting uses a 3-part description, as follows:
-'''To reproduce:'''
-Outline the exact steps required for someone else to recreate your bug. You can assume the reader will be familiar with the application, but you should still ensure your instructions to reproduce are clear and detailed. For example:
-''1. Log in as an administrative user''
-''2. Navigate to Browse > Archival descriptions''
-''3. Click on the "Level of description" facet for Item''
-'''Error encountered:'''
-What happens when you perform the steps described above? Include any details you think are relevant. If you think it will be helpful, you can take a screenshot of what you are seeing and attach it to the issue ticket.
-Example:
-''Results list displays items, series, and files. See attached screenshot.''
-'''Expected result:'''
-Describe to us what *should* have happened at the end of the initial steps to reproduce; what you would expect to happen if the application was responding properly. For example:
-''Archival description browse list results should be limited only to records whose level of description is "Item."
-'''Notes'''
-Not always necessary, but if there are other details that will help us, please share! What have you already tried to troubleshoot the problem? What browser were you using, and did you try to repeat the error on a different browser (or after clearing your browser cache)? Were you or your system administrator able to reproduce the problem while in Debug mode? If so, please save the stack trace (e.g. error message you see) and attach it to the issue! Is there anything particular about your installation that might be causing or affecting the bug, that we should know about? Have you added custom code to your application that is not included in a public release?
-Anything that might help us better diagnose the problem - let us know.
-==Status==
-Leave as New.
-==Priority==
-Please leave at Medium. Artefactual staff will receive triage the bug or feature as appropriate.
-==Other fields==
-Please leave blank and Artefactual staff will update as appropriate.
 [[Category:Resources]]

Difference between revisions of "Resources/Issue tracker"

Latest revision as of 07:42, 3 July 2025

Account

Page

Search