https://github.com/annakrystalli/onboarding

rOpenSci Onboarding

https://github.com/annakrystalli/onboarding

Repository

rOpenSci Onboarding

https://github.com/annakrystalli/onboarding/blob/master/

![ropensci](icon_lettering_color.png)

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)

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 receive **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 accompanying paper can, after review, be automatically submitted to the [Journal of Open-Source Software](http://joss.theoj.org/) for fast-tracked publication.

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, just click [here](https://ropensci.org/onboarding/) to fill out a short form providing your contact information and areas or expertise. We are always looking for more reviewers with both general package-writing experience and domain expertise in the fields packages are used for.

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/) (JOSS), 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).
    -   If you choose this option you should *not* submit your package to JOSS separately. It will evaluated by JOSS based on the rOpenSci review.
-   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/).

 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.md`](reviewing_guide.md) - high-level guide for reviewers
-   [`packaging_guide.md`](packaging_guide.md) - detailed requirements and recommendations for rOpenSci packages
-   [`editors_guide.md`](editors_guide.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_request_template.md`](review_request_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.

 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
-   [Malle Salmon](https://github.com/maelle), [CHAI](http://www.chaiproject.org)

### Reviewers

We are grateful to the following individuals who have offered up their time and expertise to review packages submitted to rOpenSci.

[Adam Sparks](https://github.com/adamhsparks)  [Alicia Schep](https://github.com/AliciaSchep)  [Alison Appling](https://github.com/aappling-usgs)  [Alison Boyer](https://github.com/alisonboyer)  [Amelia McNamara](https://github.com/ameliamn)  [Andee Kaplan](https://github.com/andeek)  [Andrew MacDonald](https://github.com/aammd)  [Andy Teucher](https://github.com/ateucher)  [Anna Krystalli](https://github.com/annakrystalli)  [Auriel Fournier](https://github.com/aurielfournier)  [Bea Hernandez](https://github.com/chucheria)  [Ben Bond-Lamberty](https://github.com/bpbond)  [Bob Rudis](https://github.com/hrbrmstr)  [Brooke Anderson](https://github.com/geanders)  [Carl Boettiger](https://github.com/cboettig)  [Carl Ganz](https://github.com/carlganz)  [Claudia Vitolo](https://github.com/cvitolo)  [Corinna Gries](https://github.com/cgries)  [David Gohel](https://github.com/davidgohel)  [David Winter](https://github.com/dwinter)  [Dean Attali](https://github.com/daattali)  [Dillon Niederhut](https://github.com/deniederhut)  [Edzer Pebesma](https://github.com/edzer)  [Elaine McVey](https://github.com/eamcvey)  [Emily Robinson](https://github.com/robinsones)  [Erin LeDell](https://github.com/ledell)  [Francois Michonneau](https://github.com/fmichonneau)  [Frans van Dunn](https://github.com/FvD)  [Gabe Becker](https://github.com/gmbecker)  [Gaurav Sood](https://github.com/soodoku)  [Hao Zhu](https://github.com/haozhu233)  [Hazel Kavl](https://github.com/UniversalTourist)  [Ildiko Czeller](https://github.com/czeildi)  [Ivan Hanigan](https://github.com/ivanhanigan)  [Jason Becker](https://github.com/jsonbecker)  [Jeff Hanson](https://github.com/jeffreyhanson)  [Jeff Hollister](https://github.com/jhollist)  [Jenny Bryan](https://github.com/jennybc)  [Jeroen Ooms](https://github.com/jeroen)  [Joseph Stachelek](https://github.com/jsta)  [Julia Gustavsen](https://github.com/joolia)  [Julia Silge](https://github.com/juliasilge)  [Kara Woo](https://github.com/karawoo)  [Kenneth Benoit](https://github.com/kbenoit)  [Kent Russel](https://github.com/timelyportfolio)  [Kevin Ushey](https://github.com/kevinushey)  [Laura DeCicco](https://github.com/ldecicco-usgs)  [Lauren Yamane](https://github.com/layamane)  [Leah Wasser](https://github.com/lwasser)  [Lincoln Mullen](https://github.com/lmullen)  [Lucy D'Agostino McGowan](https://github.com/LucyMcGowan)  [Luke Winslow](https://github.com/lawinslow)  [Manuel Fernandez](https://github.com/manuramon)  [Mara Averick](https://github.com/batpigandme)  [Marcus Beck](https://github.com/fawda123)  [Mark Edmondson](https://github.com/MarkEdmondson1234)  [mark padgham](https://github.com/mpadge)  [Matt Mulvahill](https://github.com/mmulvahill)  [Michael Koontz](https://github.com/mikoontz)  [Michael Sumner](https://github.com/mdsumner)  [Mike Smith](https://github.com/grimbough)  [Miles McBain](https://github.com/milesmcbain)  [Najko Jahn](https://github.com/njahn82)  [Naupaka Zimmerman](https://github.com/naupaka)  [Neal Richardson](https://github.com/nealrichardson)  [Nistara Randhawa](https://github.com/nistara)  [Oliver Keyes](https://github.com/Ironholds)  [Paul Oldham](https://github.com/poldham)  [Peter Hickey](https://github.com/PeteHaitch)  [Rafael Pilliard Hellwig](https://github.com/rtaph)  [Remko Duursma](https://github.com/RemkoDuursma)  [Rich FitzJohn](https://github.com/richfitz)  [Robert Flight](https://github.com/rmflight)  [Robin Lovelace](https://github.com/Robinlovelace)  [Ross Mounce](https://github.com/rossmounce)  [Sean Hughes](https://github.com/seaaan)  [Stefan Widgren](https://github.com/stewid)  [Stephanie Locke](https://github.com/stephlocke)  [Taras Zakharko](https://github.com/tzakharko)  [Taylor Arnold](https://github.com/statsmaths)  [Ted Hart](https://github.com/emhart)  [Ted Underwood](https://github.com/tedunderwood)  [Thomas Leeper](https://github.com/leeper)  [Tiffany Timbers](https://github.com/ttimbers)  [Toph Allen](https://github.com/toph-allen)  [Tristan Mahr](https://github.com/tjmahr)  [Tuija Sonkkila](https://github.com/tts)  [Verena Haunschmid](https://github.com/expectopatronum)  [W Kyle Hamilton](https://github.com/kylehamilton)

Owner

GitHub Events