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 github issue tracker.

HOWEVER, PLEASE READ THIS PAGE FIRST, VERY CAREFULLY

... and then visit the  Issue Creation page.

Note: To make a ticket, you must have a github account. If you do not have a github account:



Please Make Sure to Fill in All Appropriate Information

Give as much information as possible such as:

  • Title: 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 in the memo field below the Title field.
    • 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.
  • Assignee: This field will be set by an OpenLayers developer.
  • Milestone: This field will be set by an OpenLayers developer.
  • Labels: Labels will be added by an OpenLayers developer.

Pull requests

See  pull requests for more information. A pull request will automatically create an issue.

If you want to attach a pull request to an existing issue, you need to use something like  hub. To provide text based attachments, use something like  gist and provide the link in the issue.

Example: 

$ git pull-request -i <issue_number> -b openlayers:master -h yourgithubuser:<your_branch>

This assumes "git" is aliased to "hub". Without -i a new pull request/issue is created.