Guide to how to add new layers #136
Comments
|
I'd like to help work on this because I would like to work on #119 and I'm trying to figure out how exactly to go about adding a layer myself. Would anyone be able to help me through this process? So far I've gotten the data from #119 and found an npm module to get/add the lat/lng data into the csv file. |
|
We may need some input from @sagarpreet-chadha on this, but basically, we add a new layer in the folder with the other layers, and for many layer types we can copy an existing one and modify it. We should make a list of what's needed, and perhaps link to a PR or two of when other layers were added, as an example. But this may need to be an evolving guide, as we're also looking to make it easier to add new layers! Here are a couple example PRs:
However, some of those layers were moved into their own code files in this PR, which is the preferred way to store them: #108 I hope this is at least a little helpful, but I think it's also a chicken and egg 🐔 🥚 problem because having a guide would help us keep this library more structured in the first place! Thank you for your interest and help!!! We're open to ideas here too! 👍 🎉 |
|
Hello, I have recently worked on adding layers and I think I can describe the procedure of adding a layer that will be beginner friendly. I feel that providing examples in codepen and a descriptive tutorial along with sample PRs might also be helpful for a beginner. What do you feel @jywarren ? |
|
That would be really awesome. Perhaps open a PR with a draft? You could add
it to the README, or make a new markdown file called CONTRIBUTING.md.
Thanks!
…On Wed, Mar 13, 2019 at 10:16 AM Ramakrishna Pattnaik < ***@***.***> wrote:
Hello, I have recently worked on adding layers and I think I can describe
the procedure of adding a layer that will be beginner friendly. I feel that
providing examples in codepen and a descriptive tutorial along with sample
PRs might also be helpful for a beginner. What do you feel @jywarren
<https://github.com/jywarren> ?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#136 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AABfJzz1fGYABFrvXCpIRlK8UB-1O560ks5vWQgggaJpZM4blwQm>
.
|
|
@jywarren I think a new file CONTRIBUTING.md will be better. I will make the PR as soon as possible. :) |
|
awesome!!
…On Wed, Mar 13, 2019 at 11:30 AM Ramakrishna Pattnaik < ***@***.***> wrote:
@jywarren <https://github.com/jywarren> I think a new file
CONTRIBUTING.md will be better. I will make the PR as soon as possible. :)
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#136 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AABfJzDeCgdcpZLJoOtjpVJ60j3BIUQlks5vWRl9gaJpZM4blwQm>
.
|
|
@jywarren I have made a codepen sample where luftdaten layer has been implemented. Does it seem sufficient to be included as a sample for guide to add new layers ? We can provide a link to the PR that adds the layer also, I think this will give new contributors a fair idea on adding a new layer. |
|
sure, anything will probably help! Thank you!
…On Thu, Mar 28, 2019 at 11:13 AM Ramakrishna Pattnaik < ***@***.***> wrote:
@jywarren <https://github.com/jywarren> I have made a codepen sample
<https://codepen.io/rkpattnaik780/full/MxMRBP> where luftdaten layer has
been implemented. Does it seem sufficient to be included as a sample for
guide to add new layers ?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#136 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AABfJyd8BrT07epa205cA_XBSG4AqFW3ks5vbNwPgaJpZM4blwQm>
.
|
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
Changes have been made to the contributing markdown as suggested in review. fixes publiclab#136
* 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 #136 * docs: update CONTRIBUTING.md Changes have been made to the contributing markdown as suggested in review. fixes #136
|
Ah, actually we have some suggested text for spreadsheet layers here! #121 |
|
I guess this issue #243 is related? |
Along with a layer submission system like #135 for people who find layers we'd like to add, we should have a README documentation section on how to actually add new layers in code. This could point at a PR which demonstrates everything you need to add one, for new coders to help out!
It could be like this file, although probably a lot simpler:
https://github.com/publiclab/image-sequencer/blob/main/CONTRIBUTING.md#contributing-modules
The text was updated successfully, but these errors were encountered: