Source of the extended version of the onboarding packaging guide. Read it here.
These guidelines are a work in progress for packages contributed to the rOpenSci suite of packages. Corrections, suggestions and general improvements are welcome as issue submissions in this repository. Open discussions are welcome in our forum. You can also make a pull request, please edit the .Rmd files that are at the root of this repository. The book will be built and automatically deployed when your PR is merged.
Deployment is done via Travis CI using the rOpenSci tic and travis packages: whenever there's a push to master, the book is built on Travis to a _book folder whose content is then pushed from Travis to the gh-pages branch. We use the setup of the example repo of a bookdown deployed with Travis. RSA keys were created and stored in the right places using travis::use_travis_deploy.
If you're an associate editor, you can also push directly to master for small fixes. We can use PRs for discussing larger updates.
If you're an associate editor and you want to render the book locally you need to install bookdown and the other dependencies stated in DESCRIPTION in particular use devtools::install_github("bergant/airtabler"), and get and store an Airtable API key following there instructions (if you're not an editor, you don't have access to our Airtable base). Then use bookdown::render_book('index.Rmd', 'bookdown::gitbook') and the book will be generated in an _output folder.
This bookdown was started using Sean Kross' minimal bookdown example that you can find here.
All of the content of this repository is licensed CC-BY-SA.