rOpenSci Packages: Development, Maintenance, and Peer Review
Source of the extended version of the onboarding packaging guide. Read it here.
Suggestions and updates
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 for typos, 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.
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.
whenever there's a push to dev, the book is built on Travis to a _book folder whose content is then pushed from Travis to the dev-site branch that gets deployed to Netlify at this address.
We copied this setup from this Data Carpentry repo.
Notes for associate editors
If you're an associate editor, you can also push directly to master for small fixes. We shall use PRs to dev for discussing larger updates, and PR from dev to master for each release.
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.
All of the content of this repository is licensed CC-BY-SA.