Submitting Bugs

From ResourceSpace Documentation Wiki

You can view ResourceSpace's Issue tracker by visiting http://bugs.resourcespace.org/. The ResourceSpace Team uses MantisBT to track and manage issues. MantisBT is a free web-based bugtracking system. More information about MantisBT can be found on the MantisBT website.

Creating an Account

Before you can report bugs using MantisBT, you must first sign up for an account.

Follow these steps to create an account:

1. In a web browser, go to http://bugs.resourcespace.org/
2. Click on the 'Signup for a new account' link at the top of the page.
3. Fill in the form with a valid username, email address, and captcha. Then, click the 'Signup' button.
4. An email will be sent to your email address containing instructions on how to complete your registration.

Submitting a new Issue

Good issue reports are the key to helping developers address problems and feature requests in ResourceSpace as quickly as possible. Trunk (SVN) versions of ResourceSpace include a link in the Team Center to assist administrators in preparing a bug report. Administrators are encouraged to use this system as it provides as much relevant information as possible.

To report a bug manually:

1. In a web browser, go to http://bugs.resourcespace.org/bug_report_page.php.
2. Fill in the Login form with your username and password, and click the 'Login' button.
3. Once you are logged in, you may be presented with a 'Select Project' form. In this case, you should select 'ResourceSpace' from the 'Choose Project' dropdown, and click the 'Select Project' button.
4. Fill in the report form as completely as possible. Providing all possible information helps developers address issues efficiently.
   • Category: Categories in Mantis represent teams of developers in the ResourceSpace community. Selecting the most appropriate category helps ensure that your report reaches the developers most likely to be able to address it.
   • Reproducibility: Select how often you can reproduce the issue.
   • Summary: A short summary of the bug.
   • Description: Write a good description of the bug, and try to be as specific as possible. Don't be afraid to write a lot of text in this field. It will better help the developers find the issue and address it.
   • Steps to reproduce: Detail any steps that will reliably reproduce this error. Including this information helps developers confirm and address your issue more quickly.

After the Report is Created

Once you have created a new report, please monitor it's status. In particular, be aware that if your issue is sent to 'feedback' a developer needs more information from you to understand your report. Also once the issue reaches the 'resolved' status, be sure to download the latest version from Subversion (or a nightly build--coming soon?) and test that your issue is addressed.

The general status cycle of a bug report is as follows:

Status	Description	Reporter Should
new	New bugs are placed into this status.	Monitor bug progress
acknowledged	A developer has inspected your report and is in the process of confirming the issue	Monitor bug progress
feedback	A developer has questions about your issue report or needs more information	Read notes from the developer and respond (by adding a note) to those questions to help the developer understand your issue
confirmed	A developer has confirmed that the issue you have raised is indeed a problem.	Monitor bug progress
assigned	A developer has assigned themselves to your issue and is working to create a patch	Monitor bug progress
waiting review	A patch has been created as is waiting for a developer with commit access to evaluate the patch	If possible, test the patch and submit a note with your results.
resolved	A patch has been created and submitted for inclusion in the marked release.	Check that the patch actually fixes your issue. If it does not, change the status to feedback and leave a note detailing your testing results. If the fix is successful, leave a note to that effect as well.
close	The fix has been confirmed and the issue is closed.	This is the end of the bug lifecycle.