OpenLayers OpenLayers

How to File A Ticket

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

HOWEVER, PLEASE READ THIS PAGE FIRST, VERY CAREFULLY

... and then visit the Ticket Creation page.

Note: To make a ticket, you must be logged into the Openlayers Trac. If you do not have a login:

  • Visit http://openlayers.org/mkpasswd.cgi , and enter a username (no spaces) and password.
  • Copy the result to an email to psc at openlayers dot org .
  • Include "Wiki/Trac password request" in the subject line.

and we will gladly make you one.
In the meantime, you can also just login as username/pass: openlayers /openlayers

Please Make Sure to Fill in All Appropriate Fields

  • Your email or username: Enter either your email address or an identifiable username. This will help us to notify you of any changes to 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. Ex:
    • Bugs
      • Double click raises error in IE 6 on WinXP
      • WMS Tiles loading outside maxExtent of map
    • Features
      • Add ability to customize style via css
      • Animated Panning
    • Tasks
      • Pull all strings out and into a single js file for localization
      • Unit tests for new Scale Based Operations
  • 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, OS
      • 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.
      • Link to code -- If you can send us a link to a site where the code with the bug lies, that is excellent. If the code is not running live on a server, attach a patch or simply a code snippet to the ticket.
      • 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 OpenLayers. 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 an OpenLayers developer.
  • Version:
    • bug - Set to the version of OpenLayers 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:
    • bug - Set to the currently under development milestone. For example, if the latest OL release is 2.2, file the bug under 2.3 Release.
    • feature, task: This will be set by a member of the SteeringCommittee
  • Components: Specify which part of OpenLayers is associated with the ticket.
  • CC: If you would like to receive notification when the ticket has been closed or changed, 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 OpenLayers developer.
  • Keywords: Can be filled with any terms you think might make your ticket easier to be located with a search.

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.