How to Report Bugs

From Coda Wiki
Jump to: navigation, search

This document is directed toward play testers, but players that wish to report bugs will also find this information useful. Here is a quick summary of the different ways to report bugs to The Coda Team. All bug reports eventually wind up in our Mantis Bug Tracking system but there are currently three different ways to send in bug reports.

  1. Email your bug to bugs@codamod.com.
  2. Post a bug report in our forums at http://codamod.com/forums/viewforum.php?f=5
  3. The fastest way is to create a bug report ticket directly in our MantisBT system by going to http://www.codagame.com/bugs .

Continue reading to find out more information about submitting useful bug reports.

This is an open Wiki, Please edit this page with anything that might make the process easier for others in the future.

Reporting bugs with MantisBT

You can view Coda's Bugtracker page by visiting http://www.codamod.com/bugs. The following instructions introduce you to MantisBT, the web-based bugtracking system used by The Coda Team, and then shows you how to properly report bugs.

What is MantisBT

Mantis Bug Tracker is a free web-based bugtracking system. You can read more about the bug tracking software we use at http://manual.mantisbt.org/.

How to report bugs using MantisBT

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://www.codamod.com/bugs/.
  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.

Creating a New Report

Once you have a valid account you may now start reporting bugs. Follow these steps to report a bug:

  1. In a web browser, go to http://www.codamod.com/bugs/bug_report_page.php. You may also use the "Report a bug" link created by the Coda Installer.
  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 'Coda' from the 'Choose Project' dropdown, and click the 'Select Project' button.
  4. Fill in the 'Enter Report Details' form, and click the 'Submit Report' button. The form's fields are described below:
    • Category: Select the most accurate category for your bug.
    • Reproducibility: Mark how often you can reproduce the bug.
    • Severity: This can be left at the default, but feature requests should be marked as 'feature'.
    • Priority: This can be left at the default setting.
    • Summary: A quick 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 Coda Team find the issue and solve it.
    • Upload File: Feel free to attach any files (e.g., screen shots, demos, logs, etc.) that you think will help better illustrate the bug you are experiencing. This report illustrates the bug with some attached screen shots. As you can see, the reporter has circled the bug with the pencil tool in Microsoft Paint in order to highlight the problem.
    • View Status: Leave this as public

After the Report is Created

Once you have created a new report, you should monitor the report's status.

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

  1. new - Your bug has been submitted to the development team. You should keep an eye on the status of your bug report.
  2. acknowledged - Bug has been looked at but not confirmed or assigned. This means a developer is looking into your bug.
  3. feedback - If a developer can't find your bug, he may set the status to 'feedback' and post questions. In this case, you should post more information about the bug, or answer any questions the developer has posted.
  4. confirmed - Confirmed and reproducible. A Developer was able to confirm and reproduce your bug.
  5. assigned - Assigned to a Developer. This means a developer is currently trying to fix the bug.
  6. resolved - Bug should be fixed, waiting on confirmation of fix. You should test the fix, and add a note to the report confirming or denying the validity of the bug fix.
  7. closed - Bug is closed. You have confirmed the 'resolved' bug is fixed; as a result, the bug report can now be closed.

For more information on this topic you can consult the http://www.mantisforge.org/dev/manual/en/administration_guide/x371.html

Submitting a Crash Report

After a crash to the desktop, you should immediately use the CodaBug.exe program to submit a crash report to the Coda Team. The CodaBug.exe program is very similar to the MantisBT web interface except it automatically attaches important information to the report.

Follow these steps to report a crash:

  1. From the start menu, select Coda Mod Alpha and then select Crash Report, or you can launch CodaBug from the 'Coda Crash Report' link on your desktop.
  2. Fill in your Coda MantisBT username and password.
  3. Write a short summary of how the crash occurred.
  4. Write a description of what was taking place when the crash occurred.
  5. CodaBug will automatically find your log files and attachment them to your report.
  6. Click the "Submit Report" button.

Reporting bugs using the forums

Posting Bug Reports in the Forum

If the bug tracking system is to much work you can also post bug reports in our forums.

  1. In a web browser, go to http://www.codamod.com/forums/viewforum.php?f=5
  2. In order to post, you will need to be logged in with your Coda Forum account. If you do not have an account, you will need to sign up for a new one using a valid email address in order to confirm your account.
  3. If a post already exists that describes a bug similar to the one you are experiencing, reply to said post and add your bug report information. Otherwise, continue to the next step.
  4. If your bug hasn't been posted then start a New Topic.
  5. Fill in the post subject with a short description of the bug.
  6. The body of your post should contain a longer description of the bug and try to be as specific as possible.
  7. Feel free to attach any files (e.g., screen shots, demos, logs, etc.) that you think will help better illustrate the bug you are experiencing. For example, the files attached to this bug report help better illustrate the bug. As you can see, the reporter has circled the bug with the pencil tool in Microsoft Paint in order to highlight the problem.

Reporting bugs using email

Emailing Bug Reports

If the bug tracking system and forums are to much work you can always email your bug reports to bugs@codamod.com.

  1. Address the email to bugs@codamod.com
  2. Fill in the subject with a short description of the bug.
  3. The body of your email should contain a longer description of the bug and try to be as specific as possible.
  4. Feel free to attach any files (e.g., screen shots, demos, logs, etc.) that you think will help better illustrate the bug you are experiencing. For example, the files attached to this bug report help better illustrate the bug. As you can see, the reporter has circled the bug with the pencil tool in Microsoft Paint in order to highlight the problem.

Creating files for bug reports

Recording Demos

Unreal Tournament 3 allows players to record a portion of gameplay as a demo file, which can be played back later on. These can be used to archive interesting or problematic behaviors for game balance or bug solving purposes.

Follow these steps to record a demo:

  1. Get the scene ready to reproduce the bug.
  2. Use the console (F10 or Tab key) and type "demorec MYDEMO" where MYDEMO is the name of the demo file you will produce. Demo files can become quite large, so please be concise with what you choose to record.
  3. When you've finished reproducing the bug, type "demostop". Your new demo file can be found in your "Documents\My Games\Unreal Tournament 3\UTGame\Demos" directory. You can view previously recorded demos with the "demoplay DEMONAME" command.
  4. Attach the demo to your bug report.
  5. Attach the ReleaseInfo.ini file located at "<CodaInstallDir>\Documentation\ReleaseInfo.ini" where <CodaInstallDir> is the directory where you installed Coda (e.g, "My Documents\My Games\Unreal Tournament 3\Coda\").

Creating Screen Shots

Unreal Tournament 3 allows you to take screen shots. These can be very helpful when trying to describe a bug.

Follow these steps to submit a screen shot with a bug report:

  1. Press the F9 key while the bug is on screen.
  2. The screenshot can be found in your "My Documents\My Games\Unreal Tournament 3\UTGame\Screenshots" directory.
  3. Feel free to open the screen shot in a paint program, such as Microsoft Paint, and circle or highlight areas to better emphasize the bug.
  4. Convert the screen shot to a JPEG file.
  5. Attach the screen shot to your bug report.

FAQ

Where are log files located?

Unreal will put log files in your "Documents\My Games\Unreal Tournament 3\UTGame\Logs" directory. Attaching log files to your bug reports can be very useful to a developer.