Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create CONTRIBUTING.md #158

Merged
merged 2 commits into from
Apr 8, 2019

Conversation

rkpattnaik780
Copy link
Collaborator

@rkpattnaik780 rkpattnaik780 commented Mar 30, 2019

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.

fixes #136

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
@rkpattnaik780 rkpattnaik780 requested a review from jywarren March 30, 2019 16:51
CONTRIBUTING.md Outdated
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Osm landfill mine quarry : [#94](https://github.com/publiclab/leaflet-environmental-layers/pull/94)
* OSM landfill mine quarry : [#94](https://github.com/publiclab/leaflet-environmental-layers/pull/94)

CONTRIBUTING.md Outdated

## Bug reports

If you are submitting a bug/issue , please go to https://github.com/publiclab/leaflet-environmental-layers/issues/new
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@grvsachdeva
Copy link
Member

Also, prefer use Fixes #[issue-number] in the issue as that'll close the referenced issue when PR gets merged. Thanks!

@rkpattnaik780
Copy link
Collaborator Author

Also, prefer use Fixes #[issue-number] in the issue as that'll close the referenced issue when PR gets merged. Thanks!

Thanks, I will keep that in mind.

Changes have been made to the contributing markdown as suggested in review.

fixes publiclab#136
Copy link
Member

@grvsachdeva grvsachdeva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@jywarren jywarren merged commit f524d61 into publiclab:master Apr 8, 2019
@jywarren
Copy link
Member

jywarren commented Apr 8, 2019

Great! Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Guide to how to add new layers
3 participants