rOpenSci Packages: Development, Maintenance, and Peer Review
Clone or download
Latest commit 235422e Nov 14, 2018
Permalink
Failed to load latest commit information.
images nicer img Nov 6, 2018
inst move spelling and add @stefaniebutland and @privefl to list of contri… Jul 17, 2018
templates split templates into separate mds and read into appendix Jul 26, 2018
.gitignore update after transfer Jun 14, 2018
.travis.yml corrections Sep 27, 2018
DESCRIPTION corrections Sep 27, 2018
NEWS.md make NEWS a chapter Sep 27, 2018
README.md update README Sep 27, 2018
_bookdown.yml Start chapter for contributors cf #46 Jun 28, 2018
_output.yml less sharing for now Jun 25, 2018
appendix.Rmd make NEWS a chapter Sep 27, 2018
book.bib Initial commit Mar 26, 2018
dev_guide.Rproj Initial commit Mar 26, 2018
index.Rmd use cover-image to get a Twitter img cc @njtierney Nov 6, 2018
maintenance_collaboration.Rmd Text mini-improvements Jul 16, 2018
maintenance_contributing.Rmd Text mini-improvements Jul 17, 2018
maintenance_evolution.Rmd Text mini-improvements Jul 17, 2018
maintenance_github_grooming.Rmd update topic link cc @katrinleinweber Jul 19, 2018
maintenance_marketing.Rmd Text mini-improvements Jul 17, 2018
maintenance_releases.Rmd text edits maintenance_releases Jul 4, 2018
onboarding_author.Rmd close #68 by mentioning reviewer's guide in author's guide Jul 18, 2018
onboarding_editor.Rmd one more item Sep 10, 2018
onboarding_intro.Rmd close #70 by making intro of onboarding intro a section Jul 18, 2018
onboarding_policies.Rmd Correct typo Sep 25, 2018
onboarding_reviewer.Rmd Text mini-improvements Jul 17, 2018
pkg_building.Rmd Fix typos Nov 14, 2018
pkg_ci.Rmd more Travis info Jul 18, 2018
pkg_security.Rmd more summary writing Jun 19, 2018
preamble.tex Initial commit Mar 26, 2018
style.css try adding a custom block cf #35 Jun 19, 2018
tic.R only keep necessary stuff and add deploy from dev Sep 27, 2018

README.md

rOpenSci Packages: Development, Maintenance, and Peer Review

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Build Status

Source of the extended version of the onboarding packaging guide. Read it here.

Contributing

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.

Technical details

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.

  • 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.

Meta

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.