wiki:FilingBugs

How to File A Ticket

If you find a bug or wish to add a new feature in Fusion, please help us by filing a new ticket.

BUT FIRST, PLEASE READ THIS PAGE FIRST, VERY CAREFULLY

... and then visit the Ticket Creation page.

Fill in All Appropriate Fields

The intention of filing a ticket is to record as much information about the problem or enhancement as possible, making it easier for a developer to reproduce the problem or evaluate the enhancement.

Some important information that will help us out:

  • Log In or CC: If you have a valid OSGeo User Id, please log in before you create the ticket. This way, you will be informed of changes in your ticket. This is particularly helpful if we need more information. If you don't have an OSGeo User Id, you can get one or add your email address to the CC field of the ticket.
  • Type:
    • bug: reporting a problem
    • feature: a suggested enhancement
    • task: a procedural note
  • Short Summary: Enter a short, succinct summary of the bug, feature, or task you have identified.
  • Full description: Your thorough description of the bug/feature/task.
    • bug - This should include detailed information such that any user (with the appropriate hardware) could reproduce the bug. Please be sure to include:
      • Platform, operating system, browser, mapping software version, web server, and other related software versions
      • Detailed steps you took that caused the bug -- The importance of this cannot be sufficiently stressed. Until we can reproduce the bug on our end, there is nothing we can do to fix it.
      • Code Samples and Data -- If you can include code, application definitions, data packages or configurations that will help us reproduce the problem, please do so or indicate that you are willing to provide it directly to a developer if contacted (for data in particular).
      • Planned Solution -- If you already know how the bug needs to be fixed, detail this here.
    • feature, task - Your thorough description of the feature or task you would like to see in Fusion. Be as descriptive as possible. Some suggested points to list:
      • Functionalities - what all will it do?
      • Interdependencies
      • Changes to API?
      • Suggested strategies - how to go about implementing feature/task
      • Alternatives - are there other ways we could do this?
      • Sideaffects or complications this task might have on the rest of the project.
  • Priority: This field will be set by a Fusion developer.
  • Version:
    • bug - Set to the version of Fusion in which you found the bug. If you are working from a svn checkout, select SVN, and be sure to specify the Revision Number in the ticket's Full Description field.
    • feature, task: Leave this field blank
  • Milestone:
    • This will be set by a Fusion developer after the ticket has been analyzed.
  • Components: Specify which part of Fusion is associated with the ticket. If you can't find an appropriate component, pick the closest and describe the component in more detail in the Full Description field.
  • CC: If you would like to receive notification when the ticket has been closed or changed and you are not logged in, add your email here.
  • Assign to: If you intend to work on this bug or feature yourself, enter your username/email in this field. Otherwise, this will be set by an Fusion developer.
  • Keywords: Can be filled with any terms you think might make your ticket easier to be located with a search.
  • External ID: This is intended for organizations with separate bug tracking systems to add a reference number from their system that they can use to link to an associated issue in Fusion.
  • State: This is intended to provide a more controlled workflow around tickets. Leave as new when filing a new issue. As developers work on tickets, they can advance the state field through various stages to completion.

Patches

If you have developed a patch for the bug or feature, please attach it to the ticket. After submitting the original ticket, click the Attach File button and select the patch you have created.

Last modified 9 years ago Last modified on Mar 8, 2008 4:54:23 AM