Skip to content

Commit 76b16f0

Browse files
committed
docs: create CONTRIBUTING.md
The contributing markdown is intended to serve as a short guide for new contributors. Currently it gives a short description about adding a new layer. Other guidelines can be added to it as well. addresses publiclab#136
1 parent c028be3 commit 76b16f0

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

CONTRIBUTING.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Contributing to Leaflet Environmental Layers
2+
==========================
3+
4+
We welcome community contributions to Leaflet Environmental Layers! For local installation, follow the instructions in the [README.md file](./README.md).
5+
6+
We especially welcome contributions from people from groups underrepresented in free and open source software!
7+
8+
Our community aspires to be a respectful place. Please read and abide by our [Code of Conduct](https://publiclab.org/conduct).
9+
10+
## First Timers Welcome!
11+
12+
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:
13+
14+
* https://code.publiclab.org/#r=all
15+
* https://github.com/publiclab/leaflet-environmental-layers/issues?q=is%3Aopen+is%3Aissue+label%3Afirst-timer-only
16+
17+
Thank you so much!
18+
19+
Learn more about contributing to Public Lab code projects on these pages:
20+
21+
* https://publiclab.org/developers
22+
* https://publiclab.org/contributing-to-public-lab-software
23+
* https://publiclab.org/soc
24+
* https://publiclab.org/wiki/developers
25+
* https://publiclab.org/wiki/gsoc-ideas
26+
27+
## Adding a new layer
28+
29+
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).
30+
31+
### Steps to add a new layer :
32+
1. Find an issue labelled <i>new layer</i>.
33+
2. Go through the documentaion provided to understand how the API works.
34+
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).
35+
36+
### Some sample PRs to be referred for adding new layers:
37+
* Osm landfill mine quarry : [#94](https://github.com/publiclab/leaflet-environmental-layers/pull/94)
38+
* Indigenous Lands Treaties Layer : [#78](https://github.com/publiclab/leaflet-environmental-layers/pull/78)
39+
40+
41+
## Bug reports
42+
43+
If you are submitting a bug/issue , please go to https://github.com/publiclab/leaflet-environmental-layers/issues/new

0 commit comments

Comments
 (0)