Resources/Issue tracker - Revision history

Samason at 13:42, 3 July 2025

2025-07-03T13:42:56Z

Dan: Add footer, seealso link, TOC

2017-03-01T15:44:13Z

Add footer, seealso link, TOC

Dan: Fix link to wishlist info in wiki

2015-06-19T21:55:24Z

Fix link to wishlist info in wiki

Dan: Add links to Wishlist

2015-06-19T21:52:33Z

Add links to Wishlist

184.69.130.182 at 19:22, 21 May 2015

2015-05-21T19:22:32Z

184.69.130.182: /* Search for a bug or issue */

2015-05-21T19:21:56Z

‎Search for a bug or issue

184.69.130.182: /* Description */

2015-05-21T19:19:45Z

‎Description

184.69.130.182: /* Create a new bug or issue */

2015-05-21T19:18:18Z

‎Create a new bug or issue

184.69.130.182: /* Register for an account */ link email address

2015-05-13T19:08:05Z

‎Register for an account: link email address

184.69.130.182 at 19:07, 13 May 2015

2015-05-13T19:07:18Z

@@ Line 3: / Line 3: @@
-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
+Artefactual uses [https://github.com/artefactual/atom/issues GitHub] to track bugs and issues in AtoM.
-'''Useful links'''
+<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].
-* [https://projects.artefactual.com/projects/atom AtoM in Redmine - homepage]
+</admonition>
 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. Tasks, used more rarely, are usually reminders to developers or analysts working on a release to perform some task necessary for the related release.
+* 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.
-* An issue is given a '''Target version''' (e.g. Release 2.1, Release 2.3) '''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 via community pull request will be left without a Target version until they have been addressed, and can be associated with a specific release.
+* 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'''.
-* Bug reports should be given a '''Tested version''', 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.
+* 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].
-* Unsponsored feature requests can be found in the AtoM Wishlist project. When a wishlist ticket is sponsored for development or submitted via pull request by a community developer, the ticket will be copied into the public AtoM project.
+* 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.
-<admonition type="seealso">
+<admonition type="Important">
-* [[Resources/User_forum|Information about the AtoM User Forum]]
+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>

@@ Line 24: / Line 24: @@
 * See the Wishlist here: https://projects.artefactual.com/projects/atom-wishlist
 </admonition>
@@ Line 122: / Line 124: @@
 Please leave blank and Artefactual staff will update as appropriate.
 [[Category:Resources]]

@@ Line 21: / Line 21: @@
 <admonition type="seealso">
 We've moved all unsponsored feature request issue tickets to a new project in Redmine - the AtoM Wishlist project.
-* More information here: [[Releases/Roadmap]]
+* More information here: [[Releases/Roadmap#Wishlist|The AtoM Wishlist]]
 * See the Wishlist here: https://projects.artefactual.com/projects/atom-wishlist
 </admonition>

@@ Line 12: / Line 12: @@
 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. Tasks, used more rarely, are usually reminders to developers or analysts working on a release to perform some task necessary for the related release.
 * An issue is given a '''Target version''' (e.g. Release 2.1, Release 2.3) '''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 via community pull request will be left without a Target version until they have been addressed, and can be associated with a specific release.
 * Bug reports should be given a '''Tested version''', 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.
 * Unsponsored feature requests can be found in the AtoM Wishlist project. When a wishlist ticket is sponsored for development or submitted via pull request by a community developer, the ticket will be copied into the public AtoM project.
@@ Line 31: / Line 36: @@
 == Search for a bug or issue ==
 Anyone can search Redmine for an existing issue or bug. Visit https://projects.artefactual.com and enter your search keywords.
 You can also browse AtoM issues here: https://projects.artefactual.com/projects/atom/issues
@@ Line 41: / Line 46: @@
 == Create a new bug or issue ==
 Below are some guidelines on using the fields you will find in Redmine when you open a new AtoM issue ticket. '''Before''' doing so, however, please consider what you need to report, and what the most effective way of doing so will be! Here are some external resources to consider, that offer general guidance on bug reporting:
 Eric Raymond and Rick Moen's [http://catb.org/~esr/faqs/smart-questions.html How To Ask Questions The Smart Way] and Simon Tatham's [http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to Report Bugs Effectively] are excellent descriptions of how to write a bug report. The Mozilla Foundation's [http://developer.mozilla.org/en/Bug_writing_guidelines bug writing guidelines] may also be useful.
@@ Line 57: / Line 62: @@
 <admonition type="note">
 Unless you or your institution is sponsoring the development of a feature, or you intend to submit code yourself, please file unsponsored feature requests in the AtoM Wishlist project instead - thanks!
 </admonition>
@@ Line 81: / Line 86: @@
 '''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:
@@ Line 95: / Line 100: @@
 '''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.
@@ Line 111: / Line 116: @@
 ===Tested version===
 Please select the version of AtoM that you reproduced the bug in. If you are unsure, you can always check your installation by navigating to '''Admin > Settings''' - the first field on the settings page will tell you which version you are running. Select the corresponding version from the list.
 ===Other fields===
 Please leave blank and Artefactual staff will update as appropriate.
 [[Category:Resources]]

@@ Line 21: / Line 21: @@
-= Register for an account =
+== Register for an account ==
 You can register for an account in Redmine at: https://projects.artefactual.com/account/register
@@ Line 29: / Line 29: @@
 </admonition>
-= Search for a bug or issue =
+== Search for a bug or issue ==
 Anyone can search Redmine for an existing issue or bug. Visit https://projects.artefactual.com and enter your search keywords.
@@ Line 39: / Line 39: @@
 You can click the "Watch" link on each issue to receive an email notification whenever the issue changes. Click the "Watch" link again to disable email notifications.
-= Create a new bug or issue =
+== Create a new bug or issue ==
 Below are some guidelines on using the fields you will find in Redmine when you open a new AtoM issue ticket. '''Before''' doing so, however, please consider what you need to report, and what the most effective way of doing so will be! Here are some external resources to consider, that offer general guidance on bug reporting:

← Older revision		Revision as of 19:21, 21 May 2015
Line 36:		Line 36:

	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.		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.
		+
		+	You can click the "Watch" link on each issue to receive an email notification whenever the issue changes. Click the "Watch" link again to disable email notifications.

	= Create a new bug or issue =		= Create a new bug or issue =

@@ Line 72: / Line 72: @@
 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''
+# ''Log in as an administrative user''
-''2. Navigate to Browse > Archival descriptions''
+# ''Navigate to Browse > Archival descriptions''
-''3. Click on the "Level of description" facet for Item''
+# ''Click on the "Level of description" facet for Item''
 '''Error encountered:'''
@@ Line 95: / Line 96: @@
 Anything that might help us better diagnose the problem - let us know.
 ===Status===