Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 2.52 KB
Raw

Contributing to Leaflet Environmental Layers

We welcome community contributions to Leaflet Environmental Layers! For local installation, follow the instructions in the README.md file.

We especially welcome contributions from people from groups underrepresented in free and open source software!

Our community aspires to be a respectful place. Please read and abide by our Code of Conduct.

First Timers Welcome!

New to open source/free software? See our WELCOME PAGE, including a selection of issues we've made especially for first-timers. We're here to help, so just ask if one looks interesting:

Thank you so much!

Learn more about contributing to Public Lab code projects on these pages:

Adding a new layer

The library consists of multiple layers. It needs to add several other layers. There are issues pertaining to new layers.

Steps to add a new layer :

  1. Find an issue labelled new layer.
  2. Go through the documentation provided to understand how the API works.
  3. Here's a codepen example that consists of a base layer and Luftdaten Layer as an overlay. You can check its full implementation here.

Steps to test a new layer:

  1. Create a fixture for the layer in ./cypress/fixtures.
  2. Add a spec file for the new layer in ./cypress/integration. Please refer to one of the existing spec files for reference.
  3. Run npm run start to start a local server.
  4. Run npm run cy:run:chrome to run the tests.

Some sample PRs to be referred for adding new layers:

  • OSM landfill mine quarry : #94
  • Indigenous Lands Treaties Layer : #78

Bug reports

If you want to submit a bug/issue , please go to https://github.com/publiclab/leaflet-environmental-layers/issues/new