search

ropensci / taxa

taxonomic classes for R
https://docs.ropensci.org/taxa
Other
48 stars 12 forks source link

Add proper MIT License in LICENSE file #150

Closed zachary-foster closed 6 years ago

zachary-foster commented 6 years ago

This was a suggestion from a reviewer of the taxa paper in F1000.

sckott commented 6 years ago

yeah, it's tough one because CRAN wants the dumb one that all R pkgs have, but then if you add another license file (e.g., LICENSE-MIT or similar) github i think will then just give up cause it doesn't know which license file to use

zachary-foster commented 6 years ago

Hmm, ok, thanks for the info. I don't know much about this. I don't think it is essential though; the reviewer said it was a "minor issue"

sckott commented 6 years ago

I agree that i wish we could have a proper license file and for github to detect it so it shows up in the top license info thingy, we should look around and see if there's any solution

peterdesmet commented 6 years ago

Does CRAN look at the LICENSE file (where GitHub looks) or in the license attribute in the DESCRIPTION?

https://github.com/ropensci/taxa/blob/daf5b84ea33cfd85f814d1a114a010662d394bb2/DESCRIPTION#L21

Was also wondering (for our packages), if "MIT + file LICENSE" is a recommended practice?

zachary-foster commented 6 years ago

I think it looks at the DESCRIPTION. It looks like we have it set up the way CRAN wants:

https://cran.r-project.org/web/licenses/MIT

Its a bit cryptic, but the "MIT + file LICENSE" is mentioned

peterdesmet commented 6 years ago

Hmm, so where does the license text from that template go? Because that text would get it recognized by GitHub.

sckott commented 6 years ago

hugh, there's 5 pkgs on CRAN that have the full text of MIT license in their LICENSE file - not sure how they got it past CRAN people https://github.com/search?utf8=%E2%9C%93&q=language%3AR+license%3Amit+user%3Acran&type=Repositories

but yes, the form they want is just 

YEAR: 2018
COPYRIGHT HOLDER: Jane Doe

And the DESCRIPTION file line given above.

zachary-foster commented 6 years ago

Is the LICENSE file required by CRAN? Can we add it .Rbuildignore and put what we want in it?

sckott commented 6 years ago

yes, that format i'm pretty sure is what they want

YEAR: 2018
COPYRIGHT HOLDER: Jane Doe
zachary-foster commented 6 years ago

I think we will have to leave it the way it is to keep CRAN happy. Sorry @peterdesmet! Good idea though