Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

62 lines (47 loc) · 2.63 KB
Raw

Contributing to Leaflet.MarkerCluster

  1. Reporting Bugs
  2. Contributing Code
  3. Building

Reporting Bugs

Before reporting a bug on the project's issues page, first make sure that your issue is caused by Leaflet.MarkerCluster, not your application code (e.g. passing incorrect arguments to methods, etc.). Second, search the already reported issues for similar cases, and if it's already reported, just add any additional details in the comments.

After you've made sure that you've found a new Leaflet.markercluster bug, here are some tips for creating a helpful report that will make fixing it much easier and quicker:

  • Write a descriptive, specific title. Bad: Problem with polylines. Good: Doing X in IE9 causes Z.
  • Include browser, OS and Leaflet version info in the description.
  • Create a simple test case that demonstrates the bug (e.g. using JSFiddle or JS Bin).
  • Check whether the bug can be reproduced in other browsers.
  • Check if the bug occurs in the stable version, master, or both.
  • Bonus tip: if the bug only appears in the master version but the stable version is fine, use git bisect to find the exact commit that introduced the bug.

If you just want some help with your project, try asking on the Leaflet forum instead.

Contributing Code

Considerations for Accepting Patches

While we happily accept patches, we're also committed to keeping Leaflet simple, lightweight and blazingly fast. So bugfixes, performance optimizations and small improvements that don't add a lot of code are much more likely to get accepted quickly.

Before sending a pull request with a new feature, check if it's been discussed before already (either on GitHub issues or Leaflet UserVoice), and ask yourself two questions:

  1. Are you sure that this new feature is important enough to justify its presence in the Leaflet core? Or will it look better as a plugin in a separate repository?
  2. Is it written in a simple, concise way that doesn't add bulk to the codebase?

If your feature or API improvement did get merged into master, please consider submitting another pull request with the corresponding documentation update.

Building

Install the dependencies:

npm install -g jake
npm install

Then to build:

jake

Output will be in the dist/ directory