Skip to content

How to Contribute

Kei Saito edited this page Sep 22, 2016 · 4 revisions

Code

Here is a set of great documents about R packages from Hadley Wickham http://r-pkgs.had.co.nz/ . We recommend you to go through it to understand how R packages works in general. Especially if you are not familiar with creating R packages (not just R scripts), the namespace chapter (http://r-pkgs.had.co.nz/namespace.html) is a must read.

Test

Add at least 1 test for each exported function. Test should be runnable by devtools::test. Make sure all the test pass before submit your contribution. Refer How to Test for detail.

Test with Exploratory

Test your code on Exploratory before you submit. Refer How to Develop document how to build and deploy your code on Exploratory.

Submit

Use Pull Request to submit your contribution. Make sure that you performed all the items in the 'Checklist' section in the Pull Request template.

Clone this wiki locally