-
-
Notifications
You must be signed in to change notification settings - Fork 211
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
Add CONTRIBUTING.md ? #413
Comments
What about the one from data.table? https://github.com/Rdatatable/data.table/blob/master/Contributing.md |
Nice. Had not seen that one. Lots of good stuff in there. I guess poor Matt and Arun also get more of those than we do. Currently 1030 closed, and 388 open issues; and 7 open and 66 close pull requests. |
Here's a skeleton. It ended up being a bit longer than I wanted, but I think it reads well -- let me know what you think. Contributing to RcppInterested in contributing? We welcome bug reports and pull requests that expand and improve the functionality of Rcpp from all contributors. Reporting an IssueWhen reporting an issue, the most important thing you can provide is a reproducible example. Please include the smallest possible example that illustrates the issue -- when possible, provide a snippet of C++ code that can be run using Issues that cannot be reproduced are unlikely to receive attention, as it is often difficult, if not impossible, to ascertain whether Rcpp is truly the culprit, or what part of Rcpp could be responsible. Please also supply the output of Submitting a Pull RequestConsidering submitting a pull request? It's strongly preferred that you first post an issue outlining some motivation for your pull request first, just to ensure that some discussion around the appropriate resolution for the issue occurs first. We'd appreciate it greatly if your PR also includes unit tests, as well as updates to the ChangeLog. Please note that C++ code in Rcpp must adhere to the C++98 standard. C++11 (and above) extensions are allowed, but must be appropriately guarded so that such code still successfully compiles under the C++98 standard. Asking QuestionsPlease direct general questions to the Rcpp-devel mailing list (preferred), or alternatively post a question on Stack Overflow using the Are you a new user of Rcpp? You might find the vignettes helpful in getting acquainted with the functionality Rcpp provides. CopyrightRcpp is released as a CRAN package, licensed under the GPL-2 open source license. something that says contributions GPL-2 preferred / assumed |
Nice!! It really does read well, and better that eg the (also complete) one at data.table. GPL (>= 2) to "under the GPL-2 or later" and we may stress that folks can use other compatible licenses -- but the aggregate will always be GPL-2 or later. |
I think we need to mandate the original license (upgradable GPL) otherwise
|
Maybe. But relicensing is often generally ruled as you need buy in from all existing contributions which is rarely feasible. I'm fine either way "as long as the car is black", ie GPL (>= 2) comes up :) |
I'm just saying we can't list the package license as a simple GPL 2 if we
|
Gotcha. I was sloppy too when I said
as that is indeed a minefield. Some, such as LGPL clearly do work within the context of a GPL-2 packages. But best to avoid as much lawyering as possible. |
As just seen in #412 we ask for a certain process:
Should we spell that out in a file
CONTRIBUTING.md
which GitHub supports for these things. Has anybody seen particularly good examples?Other issues I would like to spell out
Anything else? Anybody aware of particularly nice examples?
(And things I can do without is the enforced contributor-code-of-conduct which I am not a huge fan of as an enforced extra rule.)
The text was updated successfully, but these errors were encountered: