Skip to content
rOpenSci Packages: Development, Maintenance, and Peer Review
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images 0.2.0 May 13, 2019
inst 0.2.0 May 13, 2019
templates 0.2.0 May 13, 2019
.gitignore 0.2.0 May 13, 2019
.travis.yml 0.2.0 May 13, 2019
.zenodo.json
CNAME Added CNAME for new subdomain Jan 22, 2019
DESCRIPTION install more LaTeX Feb 7, 2019
LICENSE Create LICENSE Feb 1, 2019
NEWS.md make NEWS a chapter Sep 27, 2018
README.md 0.2.0 May 13, 2019
_bookdown.yml Mass renaming of onboarding --> software peer review (#107) Dec 6, 2018
_output.yml 0.2.0 May 13, 2019
appendix.Rmd 0.2.0 May 13, 2019
book.bib Initial commit Mar 26, 2018
dev_guide.Rproj Initial commit Mar 26, 2018
index.Rmd Update index.Rmd May 13, 2019
maintenance_collaboration.Rmd 0.2.0 May 13, 2019
maintenance_contributing.Rmd
maintenance_evolution.Rmd 0.2.0 May 13, 2019
maintenance_github_grooming.Rmd Mass renaming of onboarding --> software peer review (#107) Dec 6, 2018
maintenance_marketing.Rmd 0.2.0 May 13, 2019
maintenance_releases.Rmd
pkg_building.Rmd 0.2.0 May 13, 2019
pkg_ci.Rmd 0.2.0 May 13, 2019
pkg_security.Rmd more summary writing Jun 19, 2018
preamble.tex
ropensci-dev-guide.log 0.2.0 May 13, 2019
ropensci-dev-guide.rds 0.2.0 May 13, 2019
softwarereview_author.Rmd Guidance on when to submit and package stability (#121) Jan 23, 2019
softwarereview_editor.Rmd add reminders to update airtable. resolves #113 (#117) Jan 18, 2019
softwarereview_intro.Rmd
softwarereview_policies.Rmd 0.2.0 May 13, 2019
softwarereview_reviewer.Rmd 0.2.0 May 13, 2019
style.css 0.2.0 May 13, 2019
tic.R

README.md

rOpenSci Packages: Development, Maintenance, and Peer Review

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Build Status DOI

rOpenSci's guide for packages in our suite. Read it here.

Contributing

Suggestions and updates

This book contains our guidelines for packages contributed to the rOpenSci suite of packages. They are always a work in progress - corrections, suggestions and general improvements are welcome as issue submissions in this repository. Open discussions are welcome in our forum. You can also suggest changes by editing the .Rmd files that are at the root of this repository and submitting a pull request. An "edit" button at the top of all book chapters will take you directly to the relevant page on GitHub to make such changes. Please target your pull requests to the dev branch.

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.

We copied this setup from Data Carpentry.

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 their 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 book was started using Sean Kross' minimal bookdown example.

All of the content of this repository is licensed CC-BY-SA.

You can’t perform that action at this time.