docs: create CONTRIBUTING.md #158
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,43 @@ | ||||||
| Contributing to Leaflet Environmental Layers | ||||||
| ========================== | ||||||
|
|
||||||
| We welcome community contributions to Leaflet Environmental Layers! For local installation, follow the instructions in the [README.md file](./README.md). | ||||||
|
|
||||||
| 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](https://publiclab.org/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: | ||||||
|
|
||||||
| * https://code.publiclab.org/#r=all | ||||||
| * https://github.com/publiclab/leaflet-environmental-layers/issues?q=is%3Aopen+is%3Aissue+label%3Afirst-timer-only | ||||||
|
|
||||||
| Thank you so much! | ||||||
|
|
||||||
| Learn more about contributing to Public Lab code projects on these pages: | ||||||
|
|
||||||
| * https://publiclab.org/developers | ||||||
| * https://publiclab.org/contributing-to-public-lab-software | ||||||
| * https://publiclab.org/soc | ||||||
| * https://publiclab.org/wiki/developers | ||||||
| * https://publiclab.org/wiki/gsoc-ideas | ||||||
|
|
||||||
| ## Adding a new layer | ||||||
|
|
||||||
| The library consists of multiple layers. It needs to add several other layers. There are issues pertaining to [new layers](https://github.com/publiclab/leaflet-environmental-layers/issues?q=is%3Aopen+is%3Aissue+label%3Anew-layer). | ||||||
|
|
||||||
| ### Steps to add a new layer : | ||||||
| 1. Find an issue labelled <i>new layer</i>. | ||||||
| 2. Go through the documentaion provided to understand how the API works. | ||||||
| 3. Here's a codepen example that consists of a base layer and [Luftdaten Layer](https://github.com/publiclab/leaflet-environmental-layers/issues/88) as an overlay. You can check its full implementation [here](https://github.com/publiclab/leaflet-environmental-layers/pull/137). | ||||||
|
|
||||||
| ### Some sample PRs to be referred for adding new layers: | ||||||
| * Osm landfill mine quarry : [#94](https://github.com/publiclab/leaflet-environmental-layers/pull/94) | ||||||
| * Indigenous Lands Treaties Layer : [#78](https://github.com/publiclab/leaflet-environmental-layers/pull/78) | ||||||
|
|
||||||
|
|
||||||
| ## Bug reports | ||||||
|
|
||||||
| If you are submitting a bug/issue , please go to https://github.com/publiclab/leaflet-environmental-layers/issues/new | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.