apreshill / campout

:tent:
6 stars 3 forks source link

Start of code to convert chapters and reqs #3

Closed lwjohnst86 closed 5 years ago

lwjohnst86 commented 5 years ago

Hi @apreshill! I've started to convert my scripts into functions and put them into the package.

Question, since I haven't encountered a situation like this... I've cloned your repo, but I've written the code.. so who becomes the "cre" and who goes on the LICENSE? I usually make my own packages or contribute to already well developed packages, and I've never been in the situation of contributing to a package that was just started so I don't know how these things work... thoughts?

apreshill commented 5 years ago

Hey Luke,

This is exciting- I can't wait to take them for a spin on my course! Let's definitely map out how to proceed. I should not be listed as an author of the package if my only contributions are to name the package and create the initial infrastructure. But, going forward from here, I can see a few scenarios:

  1. You write the code, docs, everything. In this case, I would remove myself as an author and happily use your package and help you with "spreading the word" if I can. I would transfer the repo to your Github.*

  2. I don't see any docs yet. I'm good at writing docs. I could go through and add the function documentation, perhaps even a vignette, and a pkgdown site to wrap it all up. In this case, I would feel comfortable listed as an author alongside you. We could discuss the maintainer role.*

  3. You write the code and docs and I offer a second set of eyeballs and offer some PRs/issues to improve the package. In this case, I would feel comfortable listed as a contributor (perhaps, depending on how much I can offer).*

I'll leave the current PR unmerged until I hear back from you. Just so you know, I'm taking some time off this week so I'll be back reliably online next week.

Thanks! Alison

*on second thought, no matter what, I think the primary repo should live in your GitHub. LMK what you think.

lwjohnst86 commented 5 years ago

Great suggestions! Um, I don't mind writing docs, but that would be great if you could take the lead on that! I'm still working away on putting my scripts into function form, but you can definitely get started writing the docs.

And ok, that makes sense about the primary repo being on my GitHub.

And no worries, enjoy the week (vacation? break?)

lwjohnst86 commented 5 years ago

@apreshill hey! I've written a working version that converts the files to the learnr format. See https://github.com/lwjohnst86/campout/issues/4. Test it out! I'd love to hear how it works!

I'm closing this PR :)