Harmonizing onboarding with JOSS

README.Rmd

@@ -0,0 +1,136 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, echo = FALSE, message=FALSE, warning=FALSE}
+library(airtabler)
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "README-"
+)
+```
+
+# rOpenSci Onboarding 
+
+Thank you for considering submitting your package to the rOpenSci suite. All
+our packages go through a process of [open peer review](https://ropensci.org/blog/2016/03/28/software-review) to ensure a consistent level of quality
+for our users. This process also allows us to ensure that your package meets
+our guidelines and provides opportunity for discussion where exceptions are
+requested.
+
+* [Why submit your package to rOpenSci?](#why-submit)
+* [Why review for rOpenSci?](#why-review)
+* [How to submit your package](#how-submit)
+* [Useful documents in this repository](#files)
+* [Editors and reviewers](#editors)
+
+# <a href="#why-submit" name="why-submit"></a>Why submit your package to rOpenSci?
+
+-   First, and foremost, we hope you submit your package for review **because you
+    value the feedback**.  We aim to provide useful feedback to package authors
+    and for [our review process] to be open, non-adversarial, and focused on
+    improving software quality.
+-   Once aboard, your package will continue to recieve **support from rOpenSci
+    members**.  You'll retain ownership  and control of of your package, but we
+    can help with ongoing maintenance issues such as those associated with
+    updates to R and dependencies and CRAN policies.
+-   rOpenSci will **promote your package** through our [web 
+    page](https://ropensci.org/packages/), [blog](https://ropensci.org/blog/),
+    and [social media](https://twitter.com/ropensci).  Packages in our suite
+    are also distributed via our [drat repository](http://packages.ropensci.org/)
+    and [Docker images](https://hub.docker.com/r/rocker/ropensci/), and listed
+    in our [task views](https://github.com/search?utf8=%E2%9C%93&q=user%3Aropensci+%22task+view%22&type=Repositories&ref=searchresults).
+-   rOpenSci **packages can be cross-listed** with other repositories such as CRAN
+    and BioConductor.
+-   rOpenSci packages that contain a short accomanying paper can, after review,
+    be automatically submitted to the
+    [Journal of Open-Source Software](http://joss.theoj.org/) for fast-tracked
+    publication.
+
+## <a href="#why-review" name="why-review"></a>Why review packages for rOpenSci?
+
+-   As in any peer-review process, we hope you choose to review **to give back
+    to the rOpenSci and scientific communities.**  Our mission to expand
+    access to scientific data and promote a culture of reproducible research
+    is only possible through the volunteer efforts of community members like you.
+-   Review is a two-way conversation. By reviewing packages, you'll have the
+    chance to **continue to learn development practices from authors and
+    other reviewers**.  
+-   The open nature of our review process allows you to **network and meet
+    colleagues and collaborators** through the review process.  Our community
+    is friendly and filled with supportive members expert in R development and
+    many other areas of science and scientific computing.
+-   To volunteer to be one of our reviewers, please e-mail us at info@ropensci.org
+    or contact us on Twitter at [@rOpenSci](https://twitter.com/rOpenSci). We
+    are always looking for more reviewers with both general package-writing experience
+    and domain expertise in the fields packages are used for.
+
+# <a href="#how-submit" name="how-submit"></a>How to submit your package for review
+
+-   Consult our [policies](policies.md) see if your package meets our
+    criteria for fitting into our suite and not overlapping with other packages.
+    -    If you are unsure whether a package meets our criteria, feel free to open
+         an issue as a pre-submission inquiry to ask if the package is appropriate.
+-   Follow our [packaging style guide](packaging_guide.md) to ensure your package
+  meets our style and quality criteria. 
+    -   If you would like your package also submitted to
+        [Journal of Open-Source Software](http://joss.theoj.org/), it should include a `paper.md`
+        file describing the package. More detail on JOSS's requirements can be found [at their website](http://joss.theoj.org/about#author_guidelines).
+-   Next, [open a new issue](https://github.com/ropensci/onboarding/issues/new) in
+this repository and fill out the template.
+-   An [editor](#editors) will review your submission within 5 business 
+    days and respond with next steps. The editor may assign the package to
+    reviewers, request that the package be updated to meet minimal criteria
+    before review, or reject the package due to lack of fit or overlap.
+-   If your package meets minimal criteria, the editor will assign  1-3 reviewers.
+    They will be asked to provide reviews as comments on your issue within 3 weeks.
+-   We ask that you respond to reviewers' comments within 2 weeks of the 
+    last-submitted review, but you may make updates to your package or respond
+    at any time.  We encourage ongoing conversations between authors and
+    reviewers. See the [reviewing guide](reviewing_guide.md) for more details.
+-   Once your package is approved, we will provide further instructions on
+    transferring your repository to the rOpenSci repository.
+
+Our [code of conduct](policies.md/#code-of-conduct) is mandatory for everyone
+involved in our review process.
+
+Our review process is always in development, and we encourage feedback and discussion
+on how to improve the process on our [forum](https://discuss.ropensci.org/).
+
+# <a href="#editors" name="editors"></a> Useful documents in this repository
+
+- [`policies.md`](policies.md) - policies as to what packages to accept and how to conduct the review process
+- [`reviewing_guide`](reviewing_guide) - high-level guide for reviewers
+- [`packaging_guide.md`](packaging_guide.md) - detailed requirements and recommendations for rOpenSci packages
+- [`editors_checklist.md`](editors_checklist.md) - steps for editors to take throughout the review process
+- [`reviewer_template.md`](reviewer_template.md) - a template and checklist for reviews
+- [`editor_template.md`](editor_template.md) - a template and checklist for editors' preliminary review
+- [`issue_template.md`](issue_template.md) - automatically-used template and checklist for authors upon submittal
+- [`review_requuest_template.md`](review_requuest_template.md) - template for e-mails to prospective reviewers
+- [`news_template.md`](news_template.md) - a template for authors to use for NEWS files in their packages.
+
+# <a href="#editors" name="editors"></a> Editors and reviewers
+
+### Associate editors
+
+rOpenSci's onboarding process is run by:
+
+* [Noam Ross](https://github.com/noamross), EcoHealth Alliance   
+* [Scott Chamberlain](https://github.com/sckott), rOpenSci  
+* [Karthik Ram](https://github.com/karthik), rOpenSci  
+
+We are grateful to the following individuals who have offered up their time and expertise to review packages submitted to rOpenSci.
+
+```{r reviewers, echo=FALSE, results='asis'}
+editors <- c("Noam Ross", "Scott Chamberlain", "Karthik Ram")
+reviewers <- airtable(base = "appZIB8hgtvjoV99D", tables = "Reviewers")$Reviewers$get()
+reviewers <- reviewers[!is.null(reviewers$Reviews) & !(reviewers$name %in% editors), ]
+reviewers <- reviewers[order(reviewers$name), ]
+cat(paste0("-   [", reviewers$name, "](https://github.com/", reviewers$github, ")", collapse = "\n"))
+```
+
+
+[![repo_banner](http://ropensci.org/assets/ropensci_repo_banner.png)](http://ropensci.org)