Source of rOpenSci blog guidance

This repository contains the source for "rOpenSci Blog Guidelines for Authors and Editors".

Deployment

The book is deployed via GitHub actions.

• Workflow for commit to main: the book is built (html) and deployed to gh-pages.

• Workflow for commit to any branch in a PR: the book is built (html) and for PRs from this repo (not forks) the result is deployed to Netlify and the preview URL is posted in the details of a PR check.

Misc

To check URLs run

source("inst/scripts/check_urls.R")
all_urls[!all_urls$ok,]

Packages needed: magrittr, fs, glue, commonmark, xml2, tibble, crul, memoise, ratelimitr, purrr.

Contributing

This is a work in progress. If you find any errors or things that need clarification, we would be grateful if you opened an issue or pull request in this repository.

We welcome contributions that adhere to our Code of Conduct.

Meta

The organization of this book was inspired by JOSS's Author and Reviewer Guides.

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