diff --git a/ACTIONS.md b/ACTIONS.md index df3fb08..2ab2a97 100644 --- a/ACTIONS.md +++ b/ACTIONS.md @@ -12,9 +12,9 @@ i.e. in the blog resource section, links to the blog guide link to #blogguide ### A note about text -Text in the **MAIN bullet** is the “common” action text, and ALSO the text to be inserted into Motivations Chapter. +Text in the **MAIN bullet** is the "common" action text, and ALSO the text to be inserted into Motivations Chapter. -Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with additional details that may differ depending on the section but which are easier to keep consistent if we have it here (e.g., for the “Write a blog post” text which occurs in three different sections), OR it shows slightly different variations on the action depending on the specific "I want to.." +Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with additional details that may differ depending on the section but which are easier to keep consistent if we have it here (e.g., for the "Write a blog post" text which occurs in three different sections), OR it shows slightly different variations on the action depending on the specific "I want to.." --- @@ -36,7 +36,7 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit ### Code of Conduct {#conduct} -* [Read our Code of Conduct](#conduct) to ensure you’re prepared to participate +* [Read our Code of Conduct](#conduct) to ensure you're prepared to participate ### Communication channels {#channels} @@ -46,12 +46,12 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit * [Subscribe to our Newsletter](#channels) * [Engage with us on Twitter](#channels). Amplify best practices from our social media to your networks. Reply to or quote a tweet to share your experience or expertise on a topic * [Ask or answer questions](#channels) in the forum or on [Slack](#channels-slack) - * [Read or ask questions](#channels) in the “Best Practices” category in our forum or on [Slack](#channels-slack) - * [Read or ask questions](#channels) in the “Packages” category in our forum or on [Slack](#channels-slack) + * [Read or ask questions](#channels) in the "Best Practices" category in our forum or on [Slack](#channels-slack) + * [Read or ask questions](#channels) in the "Packages" category in our forum or on [Slack](#channels-slack) * [Follow discussions](#channels) about statistical software peer review, best practices, and Q & A in the forum or on [Slack](#channels-slack) * [Support fellow community members](#channels) (e.g., by welcoming newcomers, giving credit, connecting members with people or resources) * [Try a 2-hour remote co-working session](#channels-slack) with someone in our Sla[Slack](#channels-slack)ck #co-working channel. Read about contributions required to join [rOpenSci Slack](#channels-slack). -* [Seek community feedback on your package ideas in the “Packages” category in our forum](#channels-forum). Ideas for new packages, package updates, or package features. +* [Seek community feedback on your package ideas in the "Packages" category in our forum](#channels-forum). Ideas for new packages, package updates, or package features. * [Browse the Jobs category](#channels) in our public forum or in **[Slack](#channels-slack) ### Community Calls {#commcalls} @@ -61,30 +61,32 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit * [Recommend topics or speakers for Community Calls](#commcalls) * [Help organize a Community Call](#commcalls) * [Propose your idea for a Community Call summary post for our blog](#commcalls) - * (Chp3 text) Take a look at examples of [community call posts](https://ropensci.org/tags/community-call/) in the [blog](#blog), consult the [blog guide](#blogguide) to see what’s involved then contact our Community Manager, Stefanie Butland, via [Slack](#channels-slack) or our [contact form](https://ropensci.org/contact/) to discuss your idea. + * (Chp3 text) Take a look at examples of [community call posts](https://ropensci.org/tags/community-call/) in the [blog](#blog), consult the [blog guide](#blogguide) to see what's involved then contact our Community Manager via our [contact form](https://ropensci.org/contact/) to discuss your idea. ### Blog {#blog} * [Submit a correction](#blog) - * (Chp3 text) See a typo or broken link in the Blog? **Submit a correction**. Open an issue in [the blog repository](https://github.com/ropensci/roweb2) or make a pull request with your suggestion and our Community Manager will review it. GitHub has helpful documentation for opening issues and making pull requests. + * (Chp3 text) See a typo or broken link in the Blog? **Submit a correction**. Open an issue in [the blog repository](https://github.com/ropensci/roweb3) or make a pull request with your suggestion and our Community Manager will review it. GitHub has helpful [documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests) for [opening issues](https://docs.github.com/en/github/managing-your-work-on-github/managing-your-work-with-issues) and [making pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). * [Read blog posts or tech notes](#blog) - * [Read blog posts or tech notes](#blog), particularly those [tagged with “Welcome”](#blog-welcome) - * [Read blog posts or tech notes](#blog), particularly those [tagged with “Reviewer”](#blog-reviewers) - * [Read blog posts or tech notes](#blog), particularly those [tagged with “Interviews”](#blog-interviews) + * [Read blog posts or tech notes](#blog), particularly those [tagged with "Welcome"](#blog-welcome) + * [Read blog posts or tech notes](#blog), particularly those [tagged with "Reviewer"](#blog-reviewers) + * [Read blog posts or tech notes](#blog), particularly those [tagged with "Interviews"](#blog-interviews) * [Read blog posts or tech notes](#blog) about specific rOpenSci packages, or about [creative use cases](#blog-usecases) for multiple rOpenSci packages * [Share posts with your network](#blog) * [Comment on a post to share your perspective or to ask a question](#blog) * **Write a blog post or tech note** (see both the [Blog](#blog) and the [Blog Guide](#blogguide)) - * (Chp3 text) Take a look at examples of posts above and on the [blog](https://ropensci.org/blog), consult the [blog guide](#blogguide) to see what’s involved then contact our Community Manager, Stefanie Butland, via [Slack](#channels-slack) or our [contact form](https://ropensci.org/contact/) to discuss your idea. + * (Chp3 text) Take a look at examples of posts above and on the [blog](https://ropensci.org/blog), consult the [blog guide](#blogguide) to see what's involved then contact our Community Manager via our [contact form](https://ropensci.org/contact/) to discuss your idea. ### Blog Guide {#blogguide} * [Submit a correction](#blogguide) - * (Chp3 text) See a typo or something that’s not clear? **Submit a correction**. Open an issue in [the blog guide repository](https://github.com/ropensci-org/blog-guidance) or make a pull request with your suggestion and one of the authors will review it. GitHub has helpful [documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests) for [opening issues](https://docs.github.com/en/github/managing-your-work-on-github/managing-your-work-with-issues) and [making pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). + * (Chp3 text) See a typo or something that's not clear? **Submit a correction**. Open an issue in [the blog guide repository](https://github.com/ropensci-org/blog-guidance) or make a pull request with your suggestion and one of the authors will review it. GitHub has helpful [documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests) for [opening issues](https://docs.github.com/en/github/managing-your-work-on-github/managing-your-work-with-issues) and [making pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). * **Write a blog post or tech note** (see both the [Blog](#blog) and the [Blog Guide](#blogguide)) - * (Chp3 text) Read about some [blog themes](#blog), browse the [Blog Guide](https://blogguide.ropensci.org/) to see what’s involved, then contact our Community Manager, Stefanie Butland, via [Slack](#channels-slack) or our [contact form](https://ropensci.org/contact/) to discuss your idea. + * (Chp3 text) Read about some [blog themes](#blog), + browse the [Blog Guide](https://blogguide.ropensci.org/) to see what's involved, + then contact our Community Manager our [contact form](https://ropensci.org/contact/) to discuss your idea. ### Packages & Docs {#packages} @@ -95,7 +97,7 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit * [Browse citations of rOpenSci packages](#packages) to find interesting applications * [Cite rOpenSci packages](#packages**)** in manuscripts and presentations and **encourage your colleagues to cite software.** Highlighting software and its maintainers will help promote software behind research * [Write a post about using rOpenSci packages** on your own blog](#packages) -* [Report a bug](#packages) by opening an issue. If you’re asking for R help, reporting a bug, or requesting a new feature, you’re more likely to succeed if you include a good [reprex](https://reprex.tidyverse.org/articles/reprex-dos-and-donts.html) (a reproducible example). +* [Report a bug](#packages) by opening an issue. If you're asking for R help, reporting a bug, or requesting a new feature, you're more likely to succeed if you include a good [reprex](https://reprex.tidyverse.org/articles/reprex-dos-and-donts.html) (a reproducible example). * [Make a pull request](#packages) * To fix a bug * To add/fix examples @@ -121,7 +123,7 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit * [Label your issues](#issues) * [Include future plans for your package](#issues) -* [Address a “Help wanted” issue](#issues) +* [Address a "Help wanted" issue](#issues) * [Address any open issue](#issues). Explore open issues in rOpenSci packages and consider submitting a fix. ### The Dev Guide: Development, maintenance, and peer review of rOpenSci packages {#devguide} @@ -130,7 +132,7 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit * [Read the Dev Guide](#devguide), especially the Reviewer Guide section * [Read the Dev Guide](#devguide), especially the CRAN Gotchas section * [Volunteer to review a package](#devguide) -* [Submit your package for peer review](#devguide) after determining whether it’s in scope for rOpenSci +* [Submit your package for peer review](#devguide) after determining whether it's in scope for rOpenSci * [Acknowledge your reviewers](#devguide) in your package DESCRIPTION (with their consent). Read about this in [Thanking Your Reviewers: Gratitude through Semantic Metadata](https://ropensci.org/blog/2018/03/16/thanking-reviewers-in-metadata/). * [Ensure your package is easily citable](#devguide) * [Volunteer to maintain or co-maintain a package](#devguide) @@ -138,9 +140,17 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit * [Publish a paper about your package](#devguide) * [Weigh in on tough technical issues on software review threads](#devguide) * [Submit a correction](#devguide) - * (Chp3 text) See a typo or broken link in the Dev Guide? **Submit a correction**. Open an issue in [the dev guide repository](https://github.com/ropensci/dev_guide) or make a pull request with your suggestion and our Community Manager will review it. GitHub has helpful documentation for opening issues and making pull requests + * (Chp3 text) See a typo or broken link in the Dev Guide? **Submit a correction**. Open an issue in [the dev guide repository](https://github.com/ropensci/dev_guide) or make a pull request with your suggestion and our Community Manager will review it. GitHub has helpful [documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests) for [opening issues](https://docs.github.com/en/github/managing-your-work-on-github/managing-your-work-with-issues) and [making pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). +### R-universe {#runiverse} +* [Explore the R-universe](#runiverse) + * [Explore the R-universe](#runiverse) and share your findings with colleagues +* [Create your own R-universe](#runiverse) + * [Create a community R-universe](#runiverse) +* [Read/Contribute to the R-universe discussion](#runiverse) +* [Report a bug in the R-universe](#runiverse) + ### Statistical Software Peer Review Book {#statsreview} * [Read our book](#statsreview) @@ -150,5 +160,5 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit ### Community Contributing Guide {#contributing} -* [Contribute something that isn’t addressed in the guide](#contributing) -* [Submit a typo fix or clarification or tell us what’s missing](#contributing) +* [Contribute something that isn't addressed in the guide](#contributing) +* [Submit a typo fix or clarification or tell us what's missing](#contributing) diff --git a/DESCRIPTION b/DESCRIPTION index 1e5c0f5..e5546e9 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: contributing-guidance Title: rOpenSci Community Contributing Guide -Version: 0.1.0 +Version: 0.2.0 Authors@R: c(person(given = "Stefanie", family = "Butland", diff --git a/appendix.Rmd b/appendix.Rmd index d59f4a6..bfcbf39 100644 --- a/appendix.Rmd +++ b/appendix.Rmd @@ -2,9 +2,11 @@ # Bibliography -We're always standing on the shoulders of giants, some of whom don't think of themselves as giants. The following resources together influenced the ideas, approach, design, tone, and content of the rOpenSci Community Contributing Guide. +We're always standing on the shoulders of giants, some of whom don't think of themselves as giants. +The following resources together influenced the ideas, approach, design, tone, and content of the rOpenSci Community Contributing Guide. -- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). Authors: https://github.com/github/opensource.guide#acknowledgments +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). +Authors: https://github.com/github/opensource.guide#acknowledgments - Dan Sholler, Igor Steinmacher, Denae Ford, Mara Averick, Mike Hoye, Greg Wilson (2019). [Ten simple rules for helping newcomers become contributors to open projects](https://doi.org/10.1371/journal.pcbi.1007296). @@ -18,7 +20,8 @@ We're always standing on the shoulders of giants, some of whom don't think of th - RStudio. [RStudio Education](https://education.rstudio.com/) -- Nadia Eghbal (2020) [Working in Public: The Making and Maintenance of Open Source Software](https://press.stripe.com/#working-in-public). Stripe Press, San Francisco, CA. +- Nadia Eghbal (2020) [Working in Public: The Making and Maintenance of Open Source Software](https://press.stripe.com/#working-in-public). +Stripe Press, San Francisco, CA. - Mozilla Open Leadership Series. [Contributor Personas & Pathways](https://mozilla.github.io/open-leadership-training-series/articles/building-communities-of-contributors/bring-on-contributors-using-personas-and-pathways/) @@ -27,7 +30,7 @@ We're always standing on the shoulders of giants, some of whom don't think of th # NEWS -## dev +## 0.2.0 * Added NEWS chapter to appendix (#35) * Update title on Zenodo (#45) @@ -38,6 +41,9 @@ We're always standing on the shoulders of giants, some of whom don't think of th * Fix Twitter link (#28) * Minor text re-wording (e.g., #34) * Switched to BS4 bookdown template +* Added new resources: Help Wanted Page, Use Cases Page, R-universe, Social Co-working +* Tweaked content +* Updated staff and community manager information ## 0.1.0 (2020-08-25) diff --git a/images/runiverse.png b/images/runiverse.png new file mode 100644 index 0000000..e5f597a Binary files /dev/null and b/images/runiverse.png differ diff --git a/images/team-all.png b/images/team-all.png index e7c3102..5da3ea5 100644 Binary files a/images/team-all.png and b/images/team-all.png differ diff --git a/index.Rmd b/index.Rmd index ea16f25..d7f6d7c 100644 --- a/index.Rmd +++ b/index.Rmd @@ -19,7 +19,7 @@ cover-image: images/contrib_guide_cover.png # {-} -```{r, echo = FALSE, fig.cap="Cover illustration by Lydia Hill"} +```{r, echo = FALSE, fig.alt = "Contributing guide cover featuring hexagonal panels each with a different person doing something different: lab work, computer work, field work, waving, hanging out with a dog/cat."} knitr::include_graphics("images/contrib_guide_cover.png") citation <- "Stefanie Butland & Steffi LaZerte. (2020). rOpenSci Community Contributing Guide (Version v0.1.0). Zenodo. http://doi.org/10.5281/zenodo.4000532" ``` diff --git a/intro_community.Rmd b/intro_community.Rmd index 6e682d1..a4bf7c7 100644 --- a/intro_community.Rmd +++ b/intro_community.Rmd @@ -1,65 +1,152 @@ ## Our Community {#community} -Our community is our best asset! Without the secret sauce that is the Humans of rOpenSci, we’re just a lot of (really good) packages and processes. Our community is an ephemeral thing. It’s everywhere and nowhere. It’s people who believe in our mission and share our values, and have a mindset for learning, improving, and innovating together. It's people who prioritize open, reusable, and reproducible research software while also prioritizing creating inclusive spaces through empathy and building trust. There are no stupid questions at rOpenSci; everyone appreciates the diversity of expertise and entryways to coding in this thing we love called R. - -**The rOpenSci community is a self-identifying group** composed of users and developers of R software tools who, together, contribute to the technical and social infrastructure for open and reproducible research. Our specific focus is on software and best practices that lower the barriers to working with scientific data sources. Community members are people who use, cite and share use cases for rOpenSci packages, attend or present in our Community Calls, write a post for our blog, participated in an rOpenSci unconf, or in our research domain focused communities like rOpenSci-Antarctic and Southern Ocean Research, answer questions in our fora, actively participate in the life of an rOpenSci project reporting problems and recommending or implementing solutions, contribute to, or maintain a package, or participate in rOpenSci peer review as a reviewer, author or editor. - -Having a diverse community is important to us. We welcome anyone dedicated to making their science more open and supporting others in that pursuit, no matter their technical expertise, career stage, or work sector. Further, we welcome people of all backgrounds, including but not limited to any sexuality, gender identity, and race. We are anti-racist. We recognize that communities are not inclusive by default, particularly as they grow: they require deliberate attention. We are all supported by rOpenSci’s [Community Manager](https://ropensci.org/author/stefanie-butland/) and a [Code of Conduct](#conduct) that has clear guidelines for behavior and reporting, and is enforced by a committee including rOpenSci staff and an independent community member. +Our community is our best asset! +Without the secret sauce that is the Humans of rOpenSci, we're just a lot of (really good) packages and processes. +Our community is an ephemeral thing. +It's everywhere and nowhere. +It's people who believe in our mission and share our values, and have a mindset for learning, improving, and innovating together. +It's people who prioritize open, reusable, and reproducible research software while also prioritizing creating inclusive spaces through empathy and building trust. +There are no stupid questions at rOpenSci; everyone appreciates the diversity of expertise and entryways to coding in this thing we love called R. + +**The rOpenSci community is a self-identifying group** composed of users and developers of R software tools who, together, contribute to the technical and social infrastructure for open and reproducible research. +Our specific focus is on software and best practices that lower the barriers to working with scientific data sources. +Community members are people who use, cite and share use cases for rOpenSci packages, +attend or present in our Community Calls, write a post for our blog, +participated in an rOpenSci unconf, or in our research domain focused communities like rOpenSci-Antarctic and Southern Ocean Research, +answer questions in our fora, actively participate in the life of an rOpenSci project reporting problems and recommending or implementing solutions, +contribute to, or maintain a package, or participate in rOpenSci peer review as a reviewer, +author or editor. + +Having a diverse community is important to us. +We welcome anyone dedicated to making their science more open and supporting others in that pursuit, +no matter their technical expertise, career stage, or work sector. +Further, we welcome people of all backgrounds, including but not limited to any sexuality, +gender identity, and race. We are anti-racist. +We recognize that communities are not inclusive by default, particularly as they grow: they require deliberate attention. +We are all supported by rOpenSci's Community Manager and a [Code of Conduct](#conduct) that has clear guidelines for behavior and reporting, and is enforced by a committee including rOpenSci staff and an independent community member. ### Humans of rOpenSci {#humans} -In this section we point to groups of people with various formal and informal roles in our community. This gives some transparency, may help people “recognize themselves” in some roles, and provide a foundation to allow folks to reach out to others to learn about making contributions. - -rOpenSci was **founded** in 2011 by [Karthik Ram](https://ropensci.org/author/karthik-ram/), [Scott Chamberlain](https://ropensci.org/author/scott-chamberlain/), and [Carl Boettiger](https://ropensci.org/author/carl-boettiger/), ecologists who were motivated to make scientific data retrieval reproducible. - -**Staff** are R users, developers, research software engineers, community builders, and an office jedi: [Karthik Ram](https://ropensci.org/author/karthik-ram/), [Scott Chamberlain](https://ropensci.org/author/scott-chamberlain/), [Jeroen Ooms](https://ropensci.org/author/jeroen-ooms/), [Stefanie Butland](https://ropensci.org/author/stefanie-butland/), [Maëlle Salmon](https://ropensci.org/author/ma%C3%ABlle-salmon/), [Mark Padgham](https://ropensci.org/author/mark-padgham/), [Steffi LaZerte](https://ropensci.org/author/steffi-lazerte/), and Stacey Dorton. - -**Strategic Advisors** [Noam Ross](https://ropensci.org/author/noam-ross/), [Carl Boettiger](https://ropensci.org/author/carl-boettiger/), [Jenny Bryan](https://ropensci.org/author/jenny-bryan/), and [Rich FitzJohn](https://ropensci.org/author/rich-fitzjohn/) volunteer their time. - -**Software peer review Editors** [Noam Ross](https://ropensci.org/author/noam-ross/), [Karthik Ram](https://ropensci.org/author/karthik-ram/), [Maëlle Salmon](https://ropensci.org/author/ma%C3%ABlle-salmon/), [Anna Krystalli](https://ropensci.org/author/anna-krystalli/), [Melina Vidoni](https://ropensci.org/author/melina-vidoni/), [Brooke Anderson](https://ropensci.org/author/brooke-anderson/), [Mauro Lepore](https://ropensci.org/author/mauro-lepore/), [Laura DeCicco](https://ropensci.org/author/laura-decicco/), and [Julia Gustavsen](https://ropensci.org/author/julia-gustavsen/) volunteer their time. [Scott Chamberlain](https://ropensci.org/author/scott-chamberlain/) and [Lincoln Mullen](https://ropensci.org/author/lincoln-mullen/) are Editor alumni. Read posts introducing [Laura DeCicco, Julia Gustavsen, Mauro Lepore](https://ropensci.org/blog/2020/10/27/editors2020/), [Brooke Anderson and Melina Vidoni](https://ropensci.org/blog/2019/01/31/more_editors/), and [Anna Krystalli and Lincoln Mullen](https://ropensci.org/blog/2018/06/22/new_editors/). We occasionally recruit [guest editors](https://devguide.ropensci.org/softwarereviewintro.html#editors-and-reviewers) for some package reviews. +In this section we point to groups of people with various formal and informal roles in our community. +This gives some transparency, may help people "recognize themselves" in some roles, +and provide a foundation to allow folks to reach out to others to learn about making contributions. + +rOpenSci was **founded** in 2011 by [Karthik Ram](https://ropensci.org/author/karthik-ram/), [Scott Chamberlain](https://ropensci.org/author/scott-chamberlain/), +and [Carl Boettiger](https://ropensci.org/author/carl-boettiger/), +ecologists who were motivated to make scientific data retrieval reproducible. + +**Staff** are R users, developers, research software engineers, community builders, +and an office jedi: [Karthik Ram](https://ropensci.org/author/karthik-ram/), +[Jeroen Ooms](https://ropensci.org/author/jeroen-ooms/), +[Maëlle Salmon](https://ropensci.org/author/ma%C3%ABlle-salmon/), +[Mark Padgham](https://ropensci.org/author/mark-padgham/), +[Steffi LaZerte](https://ropensci.org/author/steffi-lazerte/), +and Stacey Dorton. + +**Strategic Advisors** [Noam Ross](https://ropensci.org/author/noam-ross/), +[Carl Boettiger](https://ropensci.org/author/carl-boettiger/), +[Jenny Bryan](https://ropensci.org/author/jenny-bryan/), and +[Rich FitzJohn](https://ropensci.org/author/rich-fitzjohn/) volunteer their time. + +**Software peer review Editors** [Noam Ross](https://ropensci.org/author/noam-ross/), +[Karthik Ram](https://ropensci.org/author/karthik-ram/), +[Maëlle Salmon](https://ropensci.org/author/ma%C3%ABlle-salmon/), +[Anna Krystalli](https://ropensci.org/author/anna-krystalli/), +[Melina Vidoni](https://ropensci.org/author/melina-vidoni/), +[Brooke Anderson](https://ropensci.org/author/brooke-anderson/), +[Mauro Lepore](https://ropensci.org/author/mauro-lepore/), +[Laura DeCicco](https://ropensci.org/author/laura-decicco/), and +[Julia Gustavsen](https://ropensci.org/author/julia-gustavsen/) volunteer their time. +[Scott Chamberlain](https://ropensci.org/author/scott-chamberlain/) and +[Lincoln Mullen](https://ropensci.org/author/lincoln-mullen/) are Editor alumni. +Read posts introducing [Laura DeCicco, Julia Gustavsen, Mauro Lepore](https://ropensci.org/blog/2020/10/27/editors2020/), +[Brooke Anderson and Melina Vidoni](https://ropensci.org/blog/2019/01/31/more_editors/), +and [Anna Krystalli and Lincoln Mullen](https://ropensci.org/blog/2018/06/22/new_editors/). +We occasionally recruit [guest editors](https://devguide.ropensci.org/softwarereviewintro.html#editors-and-reviewers) for some package reviews. [![Headshots of the rOpensci team](images/team-all.png "Headshots of the rOpensci team")](https://ropensci.org/about/) -Get to know some of the **more experienced folks in our community** by reading the [.Rprofile series of posts](https://ropensci.org/tags/rprofile/) for which [Kelly O’Briant](https://ropensci.org/author/kelly-obriant/) interviewed [Mara Averick](https://ropensci.org/blog/2017/11/10/rprofile-mara-averick/), [Jenny Bryan](https://ropensci.org/blog/2017/12/08/rprofile-jenny-bryan/), [Julia Stewart Lowndes](https://ropensci.org/blog/2018/02/09/rprofile-julia-stewart-lowndes/) (with assistance from [Sean Kross](https://ropensci.org/author/sean-kross/)), [Karthik Ram](https://ropensci.org/blog/2018/01/12/rprofile-karthik-ram/), [Noam Ross](https://ropensci.org/blog/2018/04/13/rprofile-noam-ross/), [Julia Silge](https://ropensci.org/blog/2018/06/08/rprofile-julia-silge/), and [David Smith](https://ropensci.org/blog/2017/10/13/rprofile-david-smith/). +Get to know some of the **more experienced folks in our community** by reading the +[.Rprofile series of posts](https://ropensci.org/tags/rprofile/) for which +[Kelly O'Briant](https://ropensci.org/author/kelly-obriant/) interviewed +[Mara Averick](https://ropensci.org/blog/2017/11/10/rprofile-mara-averick/), +[Jenny Bryan](https://ropensci.org/blog/2017/12/08/rprofile-jenny-bryan/), +[Julia Stewart Lowndes](https://ropensci.org/blog/2018/02/09/rprofile-julia-stewart-lowndes/) +(with assistance from [Sean Kross](https://ropensci.org/author/sean-kross/)), +[Karthik Ram](https://ropensci.org/blog/2018/01/12/rprofile-karthik-ram/), +[Noam Ross](https://ropensci.org/blog/2018/04/13/rprofile-noam-ross/), +[Julia Silge](https://ropensci.org/blog/2018/06/08/rprofile-julia-silge/), and +[David Smith](https://ropensci.org/blog/2017/10/13/rprofile-david-smith/). Over [150 people have reviewed](https://devguide.ropensci.org/softwarereviewintro.html#editors-and-reviewers) 135 packages from **803 authors!** More than 35 people have presented in our Community Calls attended by people in more than 25 countries. -You can get to know some community members by reading the blog posts and tech notes they’ve written about their packages, their reviewer experiences, the Community Calls they’ve presented in, or their career paths in R. We have an [authors page](https://ropensci.org/author/) on our website that allows you to find these people by name. The authors page does not yet include rOpenSci package authors. - -![Some authors on rOpenSci.org](images/authors_2020-10.png "Some authors on rOpenSci.org") - -Many of rOpenSci’s tools are developed by practicing scientists and other researchers who foster strong communities among users and developers in their research domains and openly share their expertise in discussions of best practices. - -* The [Antarctic/Southern Ocean rOpenSci community](https://ropensci.org/blog/2018/11/13/antarctic/) led by [Ben Raymond](https://ropensci.org/author/ben-raymond/), [Jess Melbourne-Thomas](https://en.wikipedia.org/wiki/Jessica_Melbourne-Thomas), [Sara Labrousse](https://web.whoi.edu/jenouvrier/people/sara-labrousse-2017-present/), [Michael Sumner](https://ropensci.org/author/michael-sumner/), and [Anton Van de Putte](https://ropensci.org/author/anton-van-de-putte/) aims to strengthen the community of R users and developers in this area of research. -* Hydrology researchers [Louise Slater](https://ropensci.org/author/louise-slater/), [Sam Zipper](https://ropensci.org/author/sam-zipper/), [Sam Albers](https://ropensci.org/author/sam-albers/), [Ilaria Prosdocimi](https://ropensci.org/author/ilaria-prosdocimi/), [Claudia Vitolo](https://ropensci.org/author/claudia-vitolo/), and others promote open package development and peer review in their paper [Using R in Hydrology](https://doi.org/10.5194/hess-23-2939-2019) and some of them created and maintain the rOpenSci [Task View on hydrological data and modeling](https://github.com/ropensci/Hydrology/blob/master/README.md) in which many of the R packages have been peer reviewed through rOpenSci. -* Community members who are academic experts in climate and weather ([Brooke Anderson](https://ropensci.org/author/brooke-anderson/)), archaeology ([Ben Marwick](https://ropensci.org/author/ben-marwick/)), transport ([Robin Lovelace](https://ropensci.org/author/robin-lovelace/)), hydrology (see above), and Antarctic research (see above) highlighted sources of open data for research in their fields and the R tools to access them in [When Field or Lab Work is not an Option - Leveraging Open Data Resources for Remote Research](https://ropensci.org/blog/2020/05/19/covid-19-open-data/) - -Many in the rOpenSci community participate in related organizations and communities like [R-Ladies](https://rladies.org/), [The Carpentries](https://carpentries.org/), [Latin American R community](https://www.r-consortium.org/blog/2020/07/07/latin-american-communities-and-organizations-at-user2020), the [MiR community](https://medium.com/@doritolay/introducing-mir-a-community-for-underrepresented-users-of-r-7560def7d861) for underrepresented minority users of R, [AfricaR](https://africa-r.org/), and [Bioconductor](https://www.bioconductor.org/). - -We believe in giving credit to people for their contributions and sharing our gratitude. Our [Thank You, 2019](https://ropensci.org/blog/2019/12/23/thankyou/) post, acknowledging individual contributors, is one example of how we do that. For package authors participating in software peer review, we encourage “[gratitude through semantic metadata](https://ropensci.org/blog/2018/03/16/thanking-reviewers-in-metadata/)” with the option to acknowledge reviewers in the package DESCRIPTION (with reviewers’ consent). +You can get to know some community members by reading the blog posts and tech notes they've written about their packages, their reviewer experiences, the Community Calls they've presented in, or their career paths in R. We have an [authors page](https://ropensci.org/author/) on our website that allows you to find these people by name. The authors page does not yet include rOpenSci package authors. + +[![Screenshot of the rOpenSci authors page showing thumbnails of author avatars next to their names](images/authors_2020-10.png "Some authors on rOpenSci.org")](https://ropensci.org/authors/) + +Many of rOpenSci's tools are developed by practicing scientists and other researchers who foster strong communities among users and developers in their research domains and openly share their expertise in discussions of best practices. + +* The [Antarctic/Southern Ocean rOpenSci community](https://ropensci.org/blog/2018/11/13/antarctic/) led by [Ben Raymond](https://ropensci.org/author/ben-raymond/), +[Jess Melbourne-Thomas](https://en.wikipedia.org/wiki/Jessica_Melbourne-Thomas), +[Sara Labrousse](https://web.whoi.edu/jenouvrier/people/sara-labrousse-2017-present/), +[Michael Sumner](https://ropensci.org/author/michael-sumner/), and +[Anton Van de Putte](https://ropensci.org/author/anton-van-de-putte/) aims to strengthen the community of R users and developers in this area of research. +* Hydrology researchers [Louise Slater](https://ropensci.org/author/louise-slater/), +[Sam Zipper](https://ropensci.org/author/sam-zipper/), +[Sam Albers](https://ropensci.org/author/sam-albers/), +[Ilaria Prosdocimi](https://ropensci.org/author/ilaria-prosdocimi/), +[Claudia Vitolo](https://ropensci.org/author/claudia-vitolo/), and others promote open package development and peer review in their paper +[Using R in Hydrology](https://doi.org/10.5194/hess-23-2939-2019) and some of them created and maintain the rOpenSci +[Task View on hydrological data and modeling](https://github.com/ropensci/Hydrology/blob/master/README.md) in which many of the R packages have been peer reviewed through rOpenSci. +* Community members who are academic experts in climate and weather ([Brooke Anderson](https://ropensci.org/author/brooke-anderson/)), +archaeology ([Ben Marwick](https://ropensci.org/author/ben-marwick/)), +transport ([Robin Lovelace](https://ropensci.org/author/robin-lovelace/)), +hydrology (see above), +and Antarctic research (see above) highlighted sources of open data for research in their fields and the R tools to access them in [When Field or Lab Work is not an Option - Leveraging Open Data Resources for Remote Research](https://ropensci.org/blog/2020/05/19/covid-19-open-data/) + +Many in the rOpenSci community participate in related organizations and communities like +[R-Ladies](https://rladies.org/), +[The Carpentries](https://carpentries.org/), +[Latin American R community](https://www.r-consortium.org/blog/2020/07/07/latin-american-communities-and-organizations-at-user2020), +the [MiR community](https://medium.com/@doritolay/introducing-mir-a-community-for-underrepresented-users-of-r-7560def7d861) for underrepresented minority users of R, +[AfricaR](https://africa-r.org/), +and [Bioconductor](https://www.bioconductor.org/). + +We believe in giving credit to people for their contributions and sharing our gratitude. +Our [Thank You, 2019](https://ropensci.org/blog/2019/12/23/thankyou/) post, +acknowledging individual contributors, is one example of how we do that. +For package authors participating in software peer review, +we encourage "[gratitude through semantic metadata](https://ropensci.org/blog/2018/03/16/thanking-reviewers-in-metadata/)" with the option to acknowledge reviewers in the package DESCRIPTION (with reviewers' consent). ### The special case of rOpenSci unconfs {#unconfs} -Between 2014 and 2019 we held in-person hackathon-flavored unconferences - five in the US and four in Australia. The “[rOpenSci unconf](https://ropensci.org/blog/2017/06/02/unconf2017/)” became a place where people met, created and developed projects together, and got to know each other. You can get a feel for our unconfs by reading blog posts about [the events and projects](https://ropensci.org/tags/unconf/) and by listening to the [Credibly Curious podcast](https://soundcloud.com/crediblycurious/episode-6-oz-unconf) episode recorded during ozunconf18 by [Nick Tierney](https://ropensci.org/author/nicholas-tierney/) and [Saskia Freytag](https://twitter.com/trashystats). Through these we fostered a community of trust that functions online effectively and [with kindness](https://blogs.scientificamerican.com/observations/open-software-means-kinder-science/). Our unconfs empowered many participants to run their own local unconferences, make new projects happen, build new communities, build relationships that led to collaborations and career moves. Perhaps the biggest impact of rOpenSci unconfs was on peoples’ confidence and their perceptions of the value they each bring to the world of R in open research. +Between 2014 and 2019 we held in-person hackathon-flavored unconferences - five in the US and four in Australia. +The "[rOpenSci unconf](https://ropensci.org/blog/2017/06/02/unconf2017/)" became a place where people met, created and developed projects together, and got to know each other. +You can get a feel for our unconfs by reading blog posts about [the events and projects](https://ropensci.org/tags/unconf/) and by listening to the [Credibly Curious podcast](https://soundcloud.com/crediblycurious/episode-6-oz-unconf) episode recorded during ozunconf18 by [Nick Tierney](https://ropensci.org/author/nicholas-tierney/) and [Saskia Freytag](https://twitter.com/trashystats). +Through these we fostered a community of trust that functions online effectively and [with kindness](https://blogs.scientificamerican.com/observations/open-software-means-kinder-science/). +Our unconfs empowered many participants to run their own local unconferences, make new projects happen, build new communities, build relationships that led to collaborations and career moves. +Perhaps the biggest impact of rOpenSci unconfs was on peoples' confidence and their perceptions of the value they each bring to the world of R in open research. -Rest assured, we’re pondering how to continue building this trust network through collaborative online events. +Rest assured, we're pondering how to continue building this trust network through collaborative online events. -> The rOpenSci model has contributed much hidden skills and relationship infrastructure that has helped #rstats flourish. It's been a delight to participate in this and see people that got a start at an unconf gain confidence and grow into heavyweight community contributors and leaders over the years. +> The rOpenSci model has contributed much hidden skills and relationship infrastructure that has helped #rstats flourish. +> It's been a delight to participate in this and see people that got a start at an unconf gain confidence and grow into heavyweight community contributors and leaders over the years. >
> [Miles McBain on Twitter](https://twitter.com/MilesMcBain/status/1232458838307065858) -> My life took a turn thanks to rOpenSci - the community I was welcomed into there gave me deep friendships, new skills & confidence to get out of my comfort zone. And the #rstats world as a whole is better for rOpenSci’s existence. +> My life took a turn thanks to rOpenSci - the community I was welcomed into there gave me deep friendships, new skills & confidence to get out of my comfort zone. +> And the #rstats world as a whole is better for rOpenSci's existence. >
> [Jennifer Thompson on Twitter](https://twitter.com/jent103/status/1232460524031545344) -![Group photo from unconf17; photo credit Karthik Ram](images/unconf17_wide.jpg "Group photo from unconf17; photo credit Karthik Ram") +![Group photo from unconf17 showing a crowd of people waving at the camera; photo credit Karthik Ram](images/unconf17_wide.jpg "Group photo from unconf17; photo credit Karthik Ram") diff --git a/intro_mission.Rmd b/intro_mission.Rmd index b420abe..56fa3e9 100644 --- a/intro_mission.Rmd +++ b/intro_mission.Rmd @@ -14,8 +14,18 @@ We do this by: - Building **capacity** of software users and developers and fostering a sense of pride in their work - Promoting **advocacy** for a culture of data sharing and reusable software -Our goal is to build confidence and a sense of belonging for people of all backgrounds, particularly those who might not see themselves as software developers (as many scientists may not!). We do this through building trust and establishing shared norms for working openly, leveraging and creating open source software and resources that support open, reproducible science. - -> Everyone in the community, no matter how accomplished they are in their own specialty, comes with a mind open to learning from, with, and for each other. We learn from others by using their code and documentation, their blogs and tutorials, their talks and webinars. We learn with others online through Twitter, discussion forums and Slack channels, and in person through coding clubs, hacky hours, meetups, workshops and conferences. And we learn for others by writing tutorials and blogs about our own learning processes, or adding or fulfilling feature requests, which we can then contribute back to the community. +Our goal is to build confidence and a sense of belonging for people of all backgrounds, +particularly those who might not see themselves as software developers (as many scientists may not!). +We do this through building trust and establishing shared norms for working openly, +leveraging and creating open source software and resources that support open, reproducible science. + +> Everyone in the community, no matter how accomplished they are in their own specialty, +> comes with a mind open to learning from, with, and for each other. +> We learn from others by using their code and documentation, their blogs and tutorials, +> their talks and webinars. +> We learn with others online through Twitter, discussion forums and Slack channels, +> and in person through coding clubs, hacky hours, meetups, workshops and conferences. +> And we learn for others by writing tutorials and blogs about our own learning processes, +> or adding or fulfilling feature requests, which we can then contribute back to the community. >
> [Julia Stewart Lowndes in "Open Software Means Kinder Science"](https://blogs.scientificamerican.com/observations/open-software-means-kinder-science/) diff --git a/motivations.Rmd b/motivations.Rmd index af06c8a..fe3ce9f 100644 --- a/motivations.Rmd +++ b/motivations.Rmd @@ -1,17 +1,33 @@ # What brings you here? I want to ... {#motivations} -Contributors to rOpenSci come with a wide range of motivations, which can include wanting a tangible way to participate in open science. First-time contributions may come from people in different places on a continuum of experience: from those who consider themselves newcomers exploring the landscape and trying to see where they fit, all the way to more experienced folks who know exactly what they have to offer and what they would like to contribute. - -Contributing to rOpenSci can help you build your track record of public contributions (such as code or documentation on GitHub), and may help improve your CV for job, fellowship, or award applications. - -Participation in an open source project like rOpenSci is more likely to be a lifecycle than a linear path. Having a package pass peer review for the first time can feel like a huge milestone. You might write a blog post about the package, “give back” by participating as a reviewer or mentoring someone else in their first review, or answering questions about package maintenance. But as a person becomes more experienced, they may move on. The value someone might get out of participating here will change over time and that is perfectly ok. +Contributors to rOpenSci come with a wide range of motivations, +which can include wanting a tangible way to participate in open science. +First-time contributions may come from people in different places on a continuum of experience: +from those who consider themselves newcomers exploring the landscape and trying to see where they fit, +all the way to more experienced folks who know exactly what they have to offer and what they would like to contribute. + +Contributing to rOpenSci can help you build your track record of public contributions +(such as code or documentation on GitHub), and may help improve your CV for job, +fellowship, or award applications. + +Participation in an open source project like rOpenSci is more likely to be a lifecycle than a linear path. +Having a package pass peer review for the first time can feel like a huge milestone. +You might write a blog post about the package, +"give back" by participating as a reviewer or mentoring someone else in their first review, +or answering questions about package maintenance. +But as a person becomes more experienced, they may move on. +The value someone might get out of participating here will change over time and that is perfectly ok. > ...users pursuing their own "selfish" interests build collective value as an automatic byproduct. >
-> [Tim O’Reilly on The Architecture of Participation](https://www.oreilly.com/pub/a/tim/articles/paradigmshift_0504.html) +> [Tim O'Reilly on The Architecture of Participation](https://www.oreilly.com/pub/a/tim/articles/paradigmshift_0504.html) -Do you already know what value you want to get out of contributing? (It’s ok if you don’t know yet.) **To help you recognize yourself**, we’ve categorized what we think contributors to rOpenSci want into: [Discover](#discover); [Connect](#connect); [Learn](#learn); [Build](#build); [Help](#help). For each category, **we list examples of what those contributions might look like and we link to our [resources](#resources)** to help you get started. +Do you already know what value you want to get out of contributing? +(It's ok if you don't know yet.) +**To help you recognize yourself**, we've categorized what we think contributors to rOpenSci want into: +[Discover](#discover); [Connect](#connect); [Learn](#learn); [Build](#build); [Help](#help). +For each category, **we list examples of what those contributions might look like and we link to our [resources](#resources)** to help you get started. Choose your path. It's the journey, not the destination. diff --git a/mtv_build.Rmd b/mtv_build.Rmd index f83216e..445e2fd 100644 --- a/mtv_build.Rmd +++ b/mtv_build.Rmd @@ -1,8 +1,13 @@ ## Build {#build} -Perhaps the roles people associate most with contributing to rOpenSci involve building and influencing the research software landscape in R. This includes things like having a stake in package development and documentation, discussions on new projects like developing standards for [statistical software peer review](#statsreview), or influencing the adoption of more open and reproducible research in your department, your institution, or your field. +Perhaps the roles people associate most with contributing to rOpenSci involve building and influencing the research software landscape in R. +This includes things like having a stake in package development and documentation, +discussions on new projects like developing standards for [statistical software peer review](#statsreview), +or influencing the adoption of more open and reproducible research in your department, +your institution, or your field. -Scan the “I want to” statements below to find something that interests you. Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. +Scan the "I want to" statements below to find something that interests you. +Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. **I want to:** @@ -10,36 +15,44 @@ Improve and promote open science in my field * [Volunteer to review a package](#devguide) * Contribute to a task view. [Make a pull request](#taskviews) to add packages or details to an existing task view after discussing your approach with the maintainer -* Develop a package and [submit it for peer review](#devguide) after determining whether it’s in scope for rOpenSci +* Develop a package and [submit it for peer review](#devguide) after determining whether it's in scope for rOpenSci * [Recommend topics or speakers for Community Calls](#commcalls) * [Help organize a Community Call](#commcalls) * [Write a post about using rOpenSci packages](#packages) on your own blog * [Cite rOpenSci packages in manuscripts and presentations](#packages) * [Ensure your package is easily citable](#devguide) - +* [Explore the R-universe](#runiverse) and share your findings with colleagues +* [Create your own R-universe](#runiverse) +* [Read/Contribute to the R-universe discussion](#runiverse) +* [Report a bug in the R-universe](#runiverse) Influence package development * [Volunteer to review a package](#devguide) * [Report a bug](#packages) in an rOpenSci package * [Make a feature request](#packages) +* [Add a package idea to the Wishlist](#channels-forum) in the rOpenSci forums +* [Address an issue](#issues). Explore open issues in rOpenSci packages and consider submitting a fix. * [Make a pull request](#packages) to fix a bug or add a feature - +* [Read/Contribute to the R-universe discussion](#runiverse) +* [Report a bug in the R-universe](#runiverse) Improve package documentation and examples -* [Review documentation](#packages) and help the author by letting them know what’s unclear or [Make a pull request](#packages) to add/fix examples or to add/clarify documentation +* [Review documentation](#packages) and help the author by letting them know what's unclear or [Make a pull request](#packages) to add/fix examples or to add/clarify documentation * [Write a vignette/article for a package](#packages) * [Share a use case](#usecases) or encourage your peers to do the same Promote best practices for R development -* [Engage with us on Twitter](#channels). Amplify best practices from our social media to your networks -* [Ask or answer questions](#channels) in the the “Best Practices” category in our forum or on [Slack](#channels-slack) +* [Engage with us on Twitter](#channels). + Amplify best practices from our social media to your networks +* [Ask or answer questions](#channels) in the the "Best Practices" category in our forum or on [Slack](#channels-slack) * **Write a blog post or tech note** about the development of your rOpenSci package or your implementation of best practices (see both the [Blog](#blog) and the [Blog Guide](#blogguide)) * [Recommend topics or speakers for Community Calls](#commcalls) * [Help organize a Community Call](#commcalls) +* [Consider being a Community Host for a Coworking session](#coworking) Promote software citations @@ -52,11 +65,17 @@ Get more visibility and more users for my rOpenSci package * [Publish a paper about your package](#devguide) * [Write a post about using rOpenSci packages](#packages) on your own blog -* Write a post or tech note about your package for the rOpenSci blog (see both the [Blog](#blog) and the [Blog Guide](#blogguide)) +* Write a post or tech note about your package for the rOpenSci blog + (see both the [Blog](#blog) and the [Blog Guide](#blogguide)) +* [Create your own R-universe](#runiverse) Get people to work on open issues in my rOpenSci package * [Label your issues](#issues) to make them more discoverable * [Include future plans for your package](#issues) in the README. -* [Request a co-maintainer for your package](#devguide). Bringing on an additional maintainer can be a way to manage the volume of work, work through issues, and increase package sustainability. +* [Request a co-maintainer for your package](#devguide). + Bringing on an additional maintainer can be a way to manage the volume of work, + work through issues, and increase package sustainability. +* [Consider being a Community Host for a Coworking session](#coworking) and + supporting a mini code-a-thon. diff --git a/mtv_connect.Rmd b/mtv_connect.Rmd index 202e536..cc7f70f 100644 --- a/mtv_connect.Rmd +++ b/mtv_connect.Rmd @@ -1,25 +1,32 @@ ## Connect {#connect} -An implicit value in participating in rOpenSci is the connections people make with other scientists, R users, developers, or research software engineers who want to do their research in a more open and reproducible fashion. The rOpenSci community is a welcoming place to connect with like-minded people who share interests and values and a motivation to develop the related skills, techniques, and practices. +An implicit value in participating in rOpenSci is the connections people make with other scientists, +R users, developers, or research software engineers who want to do their research in a more open and reproducible fashion. +The rOpenSci community is a welcoming place to connect with like-minded people who share interests and values and a motivation to develop the related skills, techniques, and practices. > [Hey! You there! You are welcome here](https://ropensci.org/blog/2017/06/23/community/) >
> Shannon Ellis' rOpenSci blog post -Scan the “I want to” statements below to find something that interests you. Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. +Scan the "I want to" statements below to find something that interests you. +Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. **I want to:** Belong to a supportive community * [Read about our community](#community) -* [Meet the Humans of rOpenSci](#humans) and learn about their roles, their research, career paths, and contributions -* [Read our Code of Conduct](#conduct) to ensure you’re prepared to participate -* [Attend a Community Call](#commcalls) to get a feel for how we work and communicate with each other. See who else is interested in a topic, what questions they’re asking, ask your own questions in a collegial environment, share your expertise in a collaborative notes resource for the call -* [Read blog posts or tech notes](#blog), particularly those tagged with “Welcome” to get a feel for how we value people in our community. +* [Meet the Humans of rOpenSci](#humans) and learn about their roles, their research, + career paths, and contributions +* [Read our Code of Conduct](#conduct) to ensure you're prepared to participate +* [Attend a Community Call](#commcalls) to get a feel for how we work and communicate with each other. + See who else is interested in a topic, what questions they're asking, + ask your own questions in a collegial environment, + share your expertise in a collaborative notes resource for the call +* [Read blog posts or tech notes](#blog), particularly those tagged with "Welcome" to get a feel for how we value people in our community. * [Support fellow community members](#channels) (e.g., by welcoming newcomers, giving credit, connecting members with people or resources) * [Ask or answer questions](#channels) in the forum or on [Slack](#channels-slack) - +* [Join a coworking session](#coworking) and interact with others and get work done. Meet and work with other users and developers of open science packages @@ -27,20 +34,33 @@ Meet and work with other users and developers of open science packages * [Volunteer to review a package](#devguide) and use your experience to help a developer * [Volunteer to maintain or co-maintain a package](#devguide) * [Try a 2-hour remote co-working session](#channels-slack) with someone in our Slack #co-working channel. Read about contributions required to join [rOpenSci Slack](#channels-slack) -* [Seek community feedback on your package ideas in the “Packages” category in our forum](#channels-forum). Ideas for new packages, package updates, or package features. - +* [Seek community feedback on your package ideas in the "Packages" category in our forum](#channels-forum). + Ideas for new packages, package updates, or package features. +* [Join a coworking session](#coworking) to interact with other developers and get work done. Gain exposure in the open science R community * [Share a use case](#usecases) for an rOpenSci package -* [Address an issue](#issues). Explore open issues in rOpenSci packages and consider submitting a fix. +* [Address an issue](#issues). + Explore open issues in rOpenSci packages and consider submitting a fix. * [Volunteer to review a package](#devguide) * [Submit your package for peer review](#devguide) after determining whether it‘s in scope for rOpenSci -* **Write a blog post or tech note** to share your experiences (see both the [Blog](#blog) and the [Blog Guide](#blogguide)) +* **Write a blog post or tech note** to share your experiences + (see both the [Blog](#blog) and the [Blog Guide](#blogguide)) * [Ensure your package is easily citable](#devguide) +* [Create your own R-universe](#runiverse) Grow my local or topic-specific community -* [Read blog posts or tech notes](#blog), particularly those tagged with “Welcome”, “unconf”, or “icebreaker” -* [Read about our community](#community) and some of our neighbors: [rOpenSci Antarctic and Southern Ocean Research](https://ropensci.org/blog/2018/11/13/antarctic/); [R-Ladies](https://rladies.org/); [MiR Community](https://medium.com/@doritolay/introducing-mir-a-community-for-underrepresented-users-of-r-7560def7d861); [the Latin American R community](https://www.r-consortium.org/blog/2020/07/07/latin-american-communities-and-organizations-at-user2020); [Comunidad de Desarrolladores de Software en Bioinformática, CDSB](https://comunidadbioinfo.github.io/post/csdb-story-of-a-diversity-and-outreach-hotspot-in-mexico/); [Openscapes](https://www.openscapes.org/); [The Carpentries](https://carpentries.org/). +* [Read blog posts or tech notes](#blog), particularly those tagged with "Welcome", + "unconf", or "icebreaker" +* [Create a community R-universe](#runiverse) +* [Read about our community](#community) and some of our neighbors: + [rOpenSci Antarctic and Southern Ocean Research](https://ropensci.org/blog/2018/11/13/antarctic/); + [R-Ladies](https://rladies.org/); + [MiR Community](https://medium.com/@doritolay/introducing-mir-a-community-for-underrepresented-users-of-r-7560def7d861); + [the Latin American R community](https://www.r-consortium.org/blog/2020/07/07/latin-american-communities-and-organizations-at-user2020); + [Comunidad de Desarrolladores de Software en Bioinformática, CDSB](https://comunidadbioinfo.github.io/post/csdb-story-of-a-diversity-and-outreach-hotspot-in-mexico/); + [Openscapes](https://www.openscapes.org/); + [The Carpentries](https://carpentries.org/). diff --git a/mtv_discover.Rmd b/mtv_discover.Rmd index 0a683f9..267e222 100644 --- a/mtv_discover.Rmd +++ b/mtv_discover.Rmd @@ -1,8 +1,12 @@ ## Discover {#discover} -Making data, tools, and best practices more discoverable is part of [our mission](#mission). For many, using an rOpenSci package is their first encounter with our organization. It’s the most common gateway to further involvement through connections with other users, or sharing use cases, for example. +Making data, tools, and best practices more discoverable is part of [our mission](#mission). +For many, using an rOpenSci package is their first encounter with our organization. +It's the most common gateway to further involvement through connections with other users, +or sharing use cases, for example. -Scan the “I want to” statements below to find something that interests you. Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. +Scan the "I want to" statements below to find something that interests you. +Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. **I want to:** @@ -10,18 +14,24 @@ Discover packages I can use to facilitate my research and access open data * [Browse rOpenSci packages](#packages) * [Explore use cases for rOpenSci packages](#usecases) -* [Read blog posts or tech notes](#blog) about specific rOpenSci packages, about creative use cases for multiple rOpenSci packages, or about open data accessible through our packages +* [Read blog posts or tech notes](#blog) about specific rOpenSci packages, + about creative use cases for multiple rOpenSci packages, + or about open data accessible through our packages * [Browse task views](#taskviews) to discover packages to use * [Subscribe to our Newsletter](#channels) * [Follow rOpenSci on Twitter](#channels) -* [Follow roknowtifier on Twitter](#channels) to get notified about new packages and package updates in real time -* [Browse citations of rOpenSci packages](#packages) to see what other researchers are using +* [Follow roknowtifier on Twitter](#channels) to get notified about new + packages and package updates in real time +* [Browse citations of rOpenSci packages](#packages) to see what other + researchers are using +* [Explore the R-universe](#runiverse) Discover resources on best practices for software development * [Read the Dev Guide](#devguide) -* [Read or ask questions](#channels) in the “Best Practices” category in our forum or on [Slack](#channels-slack) +* [Read or ask questions](#channels) in the "Best Practices" category in our + forum or on [Slack](#channels-slack) * [Attend a Community Call](#commcalls) * [Watch recordings and read collaborative notes from past Community Calls](#commcalls) * [Read blog posts or tech notes](#blog) @@ -29,5 +39,6 @@ Discover resources on best practices for software development Discover resources on community building -* [Read blog posts or tech notes](#blog), particularly those tagged with “Welcome”, “unconf”, or “icebreaker” +* [Read blog posts or tech notes](#blog), + particularly those tagged with "Welcome", "unconf", or "icebreaker" * [Read about our community](#community) and some of the communities built by our members diff --git a/mtv_help.Rmd b/mtv_help.Rmd index 146e772..8247ef4 100644 --- a/mtv_help.Rmd +++ b/mtv_help.Rmd @@ -1,8 +1,15 @@ ## Help {#help} -One major motivation for contributing to rOpenSci is people’s desire to “give back” in appreciation of good software, good infrastructure, and a good community in which folks share their gratitude often and openly. The ways you can help are limitless. We encourage people to support others by sharing their experience or expertise. Don’t underestimate the value of sharing your first-time experience doing a thing; that is an immense help to others who don’t yet recognize the value of their own contributions. +One major motivation for contributing to rOpenSci is people's desire to +"give back" in appreciation of good software, good infrastructure, +and a good community in which folks share their gratitude often and openly. +The ways you can help are limitless. We encourage people to support others by +sharing their experience or expertise. +Don't underestimate the value of sharing your first-time experience doing a thing; +that is an immense help to others who don't yet recognize the value of their own contributions. -Scan the “I want to” statements below to find something that interests you. Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. +Scan the "I want to" statements below to find something that interests you. +Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. **I want to:** @@ -13,18 +20,25 @@ Support rOpenSci or give back to open source * [Cite rOpenSci packages](#packages) in manuscripts and presentations and encourage your colleagues to cite software * [Ensure your package is easily citable](#devguide) * [Submit a use case](#usecases) for an rOpenSci package -* [Engage with us on Twitter](#channels). Amplify best practices from our social media to your networks. Reply to or quote a tweet to share your experience or expertise on a topic +* [Address an issue](#issues). + Explore open issues in rOpenSci packages and consider submitting a fix. +* [Contribute to the R-universe discussion](#runiverse) +* [Report a bug in the R-universe](#runiverse) +* [Engage with us on Twitter](#channels). Amplify best practices from our social media to your networks. + Reply to or quote a tweet to share your experience or expertise on a topic * [Weigh in on tough technical issues on software review threads](#devguide) * [Donate](https://ropensci.org/donate/) to rOpenSci Help other community members -* [Volunteer to review a package](#devguide). We appreciate having experienced reviewers who are willing to be paired with a first-time reviewer +* [Volunteer to review a package](#devguide). + We appreciate having experienced reviewers who are willing to be paired with a first-time reviewer * [Answer questions](#channels) in the forum or on [Slack](#channels-slack) -* [Support fellow community members](#channels) (e.g., by welcoming newcomers, giving credit, connecting members with people or resources) - +* [Support fellow community members](#channels) + (e.g., by welcoming newcomers, giving credit, connecting members with people or resources) +* [Join a coworking session](#coworking) and answer questions Provide something I think the community is missing -* [Contribute something that isn’t addressed in this Contributing Guide](#contributing) +* [Contribute something that isn't addressed in this Contributing Guide](#contributing) diff --git a/mtv_learn.Rmd b/mtv_learn.Rmd index 68bc052..3da9384 100644 --- a/mtv_learn.Rmd +++ b/mtv_learn.Rmd @@ -1,9 +1,15 @@ ## Learn {#learn} -rOpenSci provides avenues for new and more seasoned R users and developers to learn - from learning by reading and listening, to learning by doing. All in an atmosphere of trust, generosity, giving credit, and sharing gratitude. We focus here on using, developing, documenting code, and building community, as they specifically align with our mission. People looking for more general R learning may refer to [RStudio Education](https://education.rstudio.com/) and [The Carpentries](https://carpentries.org/). +rOpenSci provides avenues for new and more seasoned R users and developers to learn - +from learning by reading and listening, to learning by doing. +All in an atmosphere of trust, generosity, giving credit, and sharing gratitude. +We focus here on using, developing, documenting code, and building community, +as they specifically align with our mission. +People looking for more general R learning may refer to [RStudio Education](https://education.rstudio.com/) and [The Carpentries](https://carpentries.org/). -Scan the “I want to” statements below to find something that interests you. Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. +Scan the "I want to" statements below to find something that interests you. +Click on any action under a statement to go to a description of the relevant rOpenSci resource with details on how to contribute. **I want to:** @@ -13,41 +19,51 @@ Be informed by reading and listening * [Follow roknowtifier on Twitter](#channels) to get notifications about new packages and package updates in real time * [Subscribe to our Newsletter](#channels) * [Read blog posts or tech notes](#blog) +* [Read the R-universe discussion](#runiverse) * [Attend a Community Call](#commcalls) * [Watch recordings and read collaborative notes from past Community Calls](#commcalls) * [Explore use cases](#usecases) shared by community members -* [Follow discussions](#channels) about statistical software peer review, best practices, and Q & A in the forum or on [Slack](#channels-slack) - +* [Follow discussions](#channels) about statistical software peer review, + best practices, and Q & A in the forum or on [Slack](#channels-slack) +* [Join a coworking session](#coworking) and listen to questions and answers Improve the reproducibility of my research and apply best practices in my work * [Use an rOpenSci package](#packages) if it does something you need instead of writing new code yourself -* [Attend a Community Call](#commcalls) or [watch recordings and read collaborative notes from past Community Calls](#commcalls). Some past calls have covered these topics +* [Attend a Community Call](#commcalls) or + [watch recordings and read collaborative notes from past Community Calls](#commcalls). + Some past calls have covered these topics * [Read the Dev Guide](#devguide) and adopt some new best practices * [Read our book on Statistical Software Peer Review](#statsreview) to familiarize yourself with standards being developed -* [Read or ask questions](#channels) in the “Best Practices” category in our forum or on [Slack](#channels-slack) -* [Submit your package for peer review](#devguide) after determining whether it’s in scope for rOpenSci +* [Read or ask questions](#channels) in the "Best Practices" category in our forum or on [Slack](#channels-slack) +* [Submit your package for peer review](#devguide) after determining whether it's in scope for rOpenSci Improve my R and software development skills -* Find new packages to try: [Browse rOpenSci packages](#packages), [explore use cases](#usecases), [read blog posts or tech notes](#blog) +* Find new packages to try: [Browse rOpenSci packages](#packages), + [explore use cases](#usecases), [read blog posts or tech notes](#blog) * [Volunteer to review a package](#devguide) -* [Seek community feedback on your package ideas in the “Packages” category in our forum](#channels-forum) +* [Seek community feedback on your package ideas in the "Packages" category in our forum](#channels-forum) * [Review package documentation](#packages) +* [Address an issue](#issues). + Explore open issues in rOpenSci packages and consider submitting a fix. * [Make a pull request](#packages) to add/fix examples or clarify package documentation * [Write a vignette/article for a package](#packages) * [Share a use case](#usecases) * [Write a post about using rOpenSci packages](#packages) on your own blog -* After learning something new, **write a blog post or tech note** to share your experiences (see both the [Blog](#blog) and the [Blog Guide](#blogguide)) +* After learning something new, **write a blog post or tech note** to share your experiences + (see both the [Blog](#blog) and the [Blog Guide](#blogguide)) * [Ask or answer questions](#channels) in the forum or on [Slack](#channels-slack) * [Volunteer to maintain or co-maintain a package](#devguide) -* [Submit your package for peer review](#devguide) after determining whether it’s in scope for rOpenSci +* [Submit your package for peer review](#devguide) after determining whether it's in scope for rOpenSci +* [Join a coworking session](#coworking) and ask questions of other developers Learn how to review R code -* [Read blog posts or tech notes](#blog) written by reviewers (including some first-time reviewers) about their experiences +* [Read blog posts or tech notes](#blog) written by reviewers + (including some first-time reviewers) about their experiences * [Read the Dev Guide](#devguide), especially the Reviewer Guide section * [Volunteer to review a package](#devguide). Learn by doing! @@ -55,13 +71,16 @@ Learn how to review R code Learn how to get my package on CRAN * [Read the Dev Guide](#devguide), especially the CRAN Gotchas section -* [Read or ask questions](#channels) in the “Packages” category in our forum or on [Slack](#channels-slack) -* [Seek community feedback on your package ideas in the “Packages” category in our forum](#channels-forum) -* [Submit your package for peer review](#devguide) after determining whether it’s in scope for rOpenSci. The review process is very useful for making sure your package is also suitable for CRAN. +* [Read or ask questions](#channels) in the "Packages" category in our forum or on + [Slack](#channels-slack) +* [Seek community feedback on your package ideas in the "Packages" category in our forum](#channels-forum) +* [Submit your package for peer review](#devguide) after determining whether it's in scope for rOpenSci. The review process is very useful for making sure your package is also suitable for CRAN. Learn about career paths in R and open science -* [Meet the Humans of rOpenSci](#humans) and learn about their roles, their research, career paths, and contributions -* [Read blog posts or tech notes](#blog), particularly those tagged with “Interviews”, which feature experienced rOpenSci community members +* [Meet the Humans of rOpenSci](#humans) and learn about their roles, + their research, career paths, and contributions +* [Read blog posts or tech notes](#blog), particularly those tagged with "Interviews", + which feature experienced rOpenSci community members * [Browse the Jobs category](#channels) in our public forum or in [Slack](#channels-slack) diff --git a/resources.Rmd b/resources.Rmd index aade8f4..93d4fa5 100644 --- a/resources.Rmd +++ b/resources.Rmd @@ -1,8 +1,12 @@ # rOpenSci Resources {#resources} -Each section of this chapter describes and links to a specific rOpenSci resource with a “How to contribute” list of actions you could take. +Each section of this chapter describes and links to a specific rOpenSci resource with a "How to contribute" list of actions you could take. -Not sure where to get started? Browse [What brings you here?](#motivations) to help you explore what you want to get out of contributing. Categories - [Discover](#discover), [Connect](#connect), [Learn](#learn), [Build](#build), [Help](#help) - each have “I want to” statements followed by examples of specific ways you can contribute. Each example links to a resource in this chapter to help you take action. +Not sure where to get started? +Browse [What brings you here?](#motivations) to help you explore what you want to get out of contributing. +Categories - [Discover](#discover), [Connect](#connect), [Learn](#learn), [Build](#build), [Help](#help) - +each have "I want to" statements followed by examples of specific ways you can contribute. +Each example links to a resource in this chapter to help you take action. ```{r child="rsrc_conduct.Rmd", echo=FALSE} @@ -14,6 +18,9 @@ Not sure where to get started? Browse [What brings you here?](#motivations) to h ```{r child="rsrc_commcalls.Rmd", echo=FALSE} ``` +```{r child="rsrc_coworking.Rmd", echo=FALSE} +``` + ```{r child="rsrc_blog.Rmd", echo=FALSE} ``` @@ -35,6 +42,9 @@ Not sure where to get started? Browse [What brings you here?](#motivations) to h ```{r child="rsrc_devguide.Rmd", echo=FALSE} ``` +```{r child="rsrc_runiverse.Rmd", echo=FALSE} +``` + ```{r child="rsrc_statsreview.Rmd", echo=FALSE} ``` diff --git a/rsrc_blog.Rmd b/rsrc_blog.Rmd index 4977f7d..9168601 100644 --- a/rsrc_blog.Rmd +++ b/rsrc_blog.Rmd @@ -1,8 +1,15 @@ ## Blog {#blog} -The rOpenSci blog contains both long form [blog posts](https://ropensci.org/blog/) and shorter [tech notes](https://ropensci.org/technotes). It’s a large, rich resource for learning about the R packages developed by staff and by community members and how people use them, the people and processes involved in our open software peer review system, and the value people get from being part of our community. We’ve published more than 500 posts since 2012 with more than half written by community members. The long form blog posts are for a broad readership, and the shorter tech notes include information on a software release with major new features, breaking changes, or significant new documentation for example. +The rOpenSci blog contains both long form [blog posts](https://ropensci.org/blog/) and shorter [tech notes](https://ropensci.org/technotes). +It's a large, rich resource for learning about the R packages developed by staff and by community members and how people use them, +the people and processes involved in our open software peer review system, and the value people get from being part of our community. +We've published more than 500 posts since 2012 with more than half written by community members. +The long form blog posts are for a broad readership, +and the shorter tech notes include information on a software release with major new features, +breaking changes, or significant new documentation for example. -This list gives you a taste of some themes. Click on a topic below to see some of our favorite examples. +This list gives you a taste of some themes. +Click on a topic below to see some of our favorite examples. ```{r posts, results="asis", message = FALSE} make_category <- function(category, posts) { @@ -41,5 +48,10 @@ There are many ways to explore our blog and tech notes content: * **Read [blog posts](https://ropensci.org/blog/) or [tech notes](https://ropensci.org/technotes/)** * Did you find an article interesting or useful? **Share posts with your network** -* **Comment on a post to share your perspective or to ask a question.** Comments appear in our [public discussion forum](#channels). -* We love to hear stories about how people use our tools and resources. Have an idea for our blog? **Write a blog post or tech note**. Take a look at examples of posts above and on the [blog](https://ropensci.org/blog), browse the [Blog Guide](https://blogguide.ropensci.org/) to see what’s involved, then contact our Community Manager, Stefanie Butland, via [Slack](#channels-slack) or our [contact form](https://ropensci.org/contact/) to propose and discuss your idea. +* **Comment on a post to share your perspective or to ask a question.** + Comments appear in our [public discussion forum](#channels). +* We love to hear stories about how people use our tools and resources. + Have an idea for our blog? **Write a blog post or tech note**. + Take a look at examples of posts above and on the [blog](https://ropensci.org/blog), + browse the [Blog Guide](https://blogguide.ropensci.org/) to see what's involved, + then contact our Community Manager via our [contact form](https://ropensci.org/contact/) to propose and discuss your idea. diff --git a/rsrc_blogguide.Rmd b/rsrc_blogguide.Rmd index dc39767..5fa2fda 100644 --- a/rsrc_blogguide.Rmd +++ b/rsrc_blogguide.Rmd @@ -1,11 +1,28 @@ ## Blog Guide {#blogguide} -Our [Blog Guide](https://blogguide.ropensci.org/) is written to help authors and editors of rOpenSci blog posts and tech notes to address frequently asked questions, and frequently given suggestions. We created it after reviewing and publishing over 100 posts by community members. +Our [Blog Guide](https://blogguide.ropensci.org/) is written to help authors and editors of rOpenSci blog posts and tech notes to address frequently asked questions, and frequently given suggestions. +We created it after reviewing and publishing over 100 posts by community members. -Chapter 1 coaches you in thinking through what you might say in a post and points to examples on different themes. Chapter 2 provides detailed technical guidelines for submitting a post - from drafting in an R Markdown or Markdown template to submitting it for review using GitHub pull request infrastructure. We provide templates, code snippets, our style guide, and checklists to help. One chapter provides some motivation for doing the extra work to contribute a post by outlining what we do to promote it to our large audience. Another outlines how to respond to an editor’s review of your draft post. +Chapter 1 coaches you in thinking through what you might say in a post and points to examples on different themes. +Chapter 2 provides detailed technical guidelines for submitting a post - +from drafting in an R Markdown or Markdown template to submitting it for review using GitHub pull request infrastructure. +We provide templates, code snippets, our style guide, and checklists to help. +One chapter provides some motivation for doing the extra work to contribute a post by outlining what we do to promote it to our large audience. +Another outlines how to respond to an editor's review of your draft post. ### How to contribute? -* **Write a blog post or tech note**. Read about some [blog themes](#blog), browse the [Blog Guide](https://blogguide.ropensci.org/) to see what’s involved, then contact our Community Manager, Stefanie Butland, via [Slack](#channels-slack) or our [contact form](https://ropensci.org/contact/) to propose and discuss your idea. -* See a typo or something that’s not clear? **Submit a correction.** Open an issue in [the Blog Guide repository](https://github.com/ropensci-org/blog-guidance) or [make a pull request](#channels-github) with your suggestion and one of the authors will review it. GitHub has helpful [documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests) for [opening issues](https://docs.github.com/en/github/managing-your-work-on-github/managing-your-work-with-issues) and [making pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). +* **Write a blog post or tech note**. + Read about some [blog themes](#blog), + browse the [Blog Guide](https://blogguide.ropensci.org/) to see what's involved, + then contact our Community Manager via our + [contact form](https://ropensci.org/contact/) to propose and discuss your idea. +* See a typo or something that's not clear? + **Submit a correction.** + Open an issue in [the Blog Guide repository](https://github.com/ropensci-org/blog-guidance) or + [make a pull request](#channels-github) with your suggestion and one of the authors will review it. + GitHub has helpful + [documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests) for + [opening issues](https://docs.github.com/en/github/managing-your-work-on-github/managing-your-work-with-issues) and + [making pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). diff --git a/rsrc_channels.Rmd b/rsrc_channels.Rmd index fc15ef3..6ec6e24 100644 --- a/rsrc_channels.Rmd +++ b/rsrc_channels.Rmd @@ -1,17 +1,25 @@ ## Communication channels {#channels} -The [Humans of rOpenSci](#humans) connect and contribute online across many timezones. We carry out our work using multiple channels for one-way and multi-way communications that involve different levels of commitment. +The [Humans of rOpenSci](#humans) connect and contribute online across many timezones. +We carry out our work using multiple channels for one-way and multi-way communications that involve different levels of commitment. -**GitHub** is the platform we use to host our software and documentation projects using Git version control. Our **newsletter**, delivered every two weeks, is the ideal way to stay informed without being overwhelmed by communication channels. We use our public **discussion forum**, **Twitter**, and **Slack**, each for specific modes of making announcements, promoting contributions from community members, asking and answering questions about rOpenSci packages and recommended best practices, knowledge-sharing and exploration of ideas, as well as more passive learning by "listening" to community wisdom. +**GitHub** is the platform we use to host our software and documentation projects using Git version control. +Our **newsletter**, delivered every two weeks, is the ideal way to stay informed without being overwhelmed by communication channels. +We use our public **discussion forum**, **Twitter**, and **Slack**, +each for specific modes of making announcements, promoting contributions from community members, +asking and answering questions about rOpenSci packages and recommended best practices, +knowledge-sharing and exploration of ideas, +as well as more passive learning by "listening" to community wisdom. -The following table lists every communication channel and its purpose. Below that we describe how we use a few specific channels and provide some advice on deciding whether a question you might have is one for rOpenSci or belongs in a more general forum. +The following table lists every communication channel and its purpose. +Below that we describe how we use a few specific channels and provide some advice on deciding whether a question you might have is one for rOpenSci or belongs in a more general forum. ```{r, results = "asis", echo = FALSE} library(tibble) library(kableExtra) tribble(~Channel, ~Purpose, - "Website ", "Home of rOpenSci", + "Website ", "Home of rOpenSci", "[Newsletter](https://news.ropensci.org/)", "A digest of R package news, use cases, blog posts, events, curated every two weeks. [Subscribe](https://news.ropensci.org/) via RSS (XML), JSON feed, or email.", "[Videos](https://vimeo.com/ropensci)", "Videos from past Community Calls on Vimeo", "[Twitter - rOpenSci](https://twitter.com/rOpenSci)", "Tweets about rOpenSci software, use cases, blog posts, tech notes, events", @@ -31,48 +39,81 @@ tribble(~Channel, ~Purpose, **GitHub** -The majority of rOpenSci’s work happens on GitHub. In this Guide we use terms like “opening an issue” to refer to tracking ideas, enhancements, tasks, or bugs in a project, and “making a pull request” to submit your proposed fix or new feature. If you’d like some general information on the language and workflow of GitHub, see [Collaborating with issues and pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests). To learn about Markdown formatting for interacting with others in issues and pull requests see [Getting started with writing and formatting on GitHub](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github). For guidance on connecting R to GitHub we recommend Happy Git and GitHub for the useR - [https://happygitwithr.com/](https://happygitwithr.com/). +The majority of rOpenSci's work happens on GitHub. +In this Guide we use terms like "opening an issue" to refer to tracking ideas, +enhancements, tasks, or bugs in a project, +and "making a pull request" to submit your proposed fix or new feature. +If you'd like some general information on the language and workflow of GitHub, +see [Collaborating with issues and pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests). +To learn about Markdown formatting for interacting with others in issues and pull requests see [Getting started with writing and formatting on GitHub](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github). +For guidance on connecting R to GitHub we recommend Happy Git and GitHub for the useR - [https://happygitwithr.com/](https://happygitwithr.com/).
**Public discussion forum** -[The forum](https://discuss.ropensci.org/) is where we encourage people to have Q & A on a wide range of topics. It is organized in categories including [Use Cases](#usecases) where people post examples of how they’ve used rOpenSci packages, [Blog](#blog) where an entry is made every time a new post or tech note appears on our blog, [Statistical Software Peer Review](#statsreview) for discussion related to developing a software peer review system for statistical software in R, Antarctic for discussions about R in Antarctic and Southern Ocean science. It includes posts like "How do you hire data people in a fair and unbiased way?" in the Community category, to specific help requests about our packages like "Taxize: Get rank of lowest common taxon". +[The forum](https://discuss.ropensci.org/) is where we encourage people to have Q & A on a wide range of topics. +It is organized in categories including [**Use Cases**](#usecases) where people post examples of how they've used rOpenSci packages, +[**Blog**](#blog) where an entry is made every time a new post or tech note appears on our blog, [**Statistical Software Peer Review**](#statsreview) for discussion related to developing a software peer review system for statistical software in R, +**Wishlist** for discussions about requested new R packages, +**Antarctic** for discussions about R in Antarctic and Southern Ocean science, and others! +It includes posts like "How do you hire data people in a fair and unbiased way?" in the Community category, to specific help requests about our packages like "Taxize: Get rank of lowest common taxon". -The benefit of posting to our forum, rather than our semi-open Slack space or by email, is that it is open for others to benefit, searchable within the forum, and discoverable by browser-based searches. Posting in the forum requires login and we encourage people to use their real names. +The benefit of posting to our forum, rather than our semi-open Slack space or by email, +is that it is open for others to benefit, searchable within the forum, +and discoverable by browser-based searches. +Posting in the forum requires login and we encourage people to use their real names.
**Slack** -We use [Slack](https://slack.com/intl/en-ca/help/articles/115004071768-What-is-Slack-) as a semi-open space for communications among people who have made specific contributions to rOpenSci. These include people who: +We use [Slack](https://slack.com/intl/en-ca/help/articles/115004071768-What-is-Slack-) as a semi-open space for communications among people who have made specific contributions to rOpenSci. +These include people who: -* have begun the [software review process for their package](#devguide) (once it’s determined to be in scope) +* have begun the [software review process for their package](#devguide) + (once it's determined to be in scope) * are assigned to [review a package](#devguide) -* made significant contributions to rOpenSci, including taking over maintenance of an rOpenSci package +* made significant contributions to rOpenSci, + including taking over maintenance of an rOpenSci package * have written a [blog post or tech note](#blog) that is published on our site * presented in a [Community Call](#commcalls) * participated in an [unconf](#unconfs) -* use R in a research domain that rOpenSci is explicitly supporting, such as Antarctic and Southern Ocean Research +* use R in a research domain that rOpenSci is explicitly supporting, + such as Antarctic and Southern Ocean Research -People join Slack by invitation from our Community Manager or other staff. If you are eligible, you may contact us via our [contact form](https://ropensci.org/contact/); provide your full name and email address. +People join Slack by invitation from our Community Manager or other staff. +If you are eligible, you may contact us via our [contact form](https://ropensci.org/contact/); +provide your full name and email address. -The benefit of Slack is the ability to more directly access rOpenSci staff and community members, including some more experienced folks in channels like #software-review or #package-maintenance, or to watch for postings in #jobs. People consider it an easier place to ask questions or explore ideas because while it has over 500 members, it’s not fully “in the open”. [We actively welcome new members](https://ropensci.org/blog/2017/07/18/value-of-welcome/) and ensure that all conversations are collegial. +The benefit of Slack is the ability to more directly access rOpenSci staff and community members, +including some more experienced folks in channels like #software-review or #package-maintenance, +or to watch for postings in #jobs. +People consider it an easier place to ask questions or explore ideas because while it has over 500 members, +it's not fully "in the open". +[We actively welcome new members](https://ropensci.org/blog/2017/07/18/value-of-welcome/) and ensure that all conversations are collegial.
**How to get help** -There is an etiquette to getting help and asking questions. We focus on using, developing, documenting code and infrastructure, and building community, as they specifically align with [our mission](#mission). +There is an etiquette to getting help and asking questions. +We focus on using, developing, documenting code and infrastructure, +and building community, as they specifically align with [our mission](#mission). People looking for more general R learning may refer to [RStudio Education](https://education.rstudio.com/) and [The Carpentries](https://carpentries.org/). -Read these posts if you have an R question: [Where to get help with your R question?](https://masalmon.eu/2018/07/22/wheretogethelp/), by Maëlle Salmon; [Getting help in R: do as I say, not as I've done](https://sctyner.me/post/2019-2-17-rhelp/), by Samantha Tyner. +Read these posts if you have an R question: +[Where to get help with your R question?](https://masalmon.eu/2018/07/22/wheretogethelp/), by Maëlle Salmon; +[Getting help in R: do as I say, not as I've done](https://sctyner.me/post/2019-2-17-rhelp/), by Samantha Tyner. -If you’re asking for R help, reporting a bug, or requesting a new feature, you’re more likely to succeed if you include a good reproducible example, a “reprex”. There’s a [well-documented package](https://reprex.tidyverse.org/) for that including a video, and an rOpenSci Community Call - [How to Ask Questions so they get Answered! Possibly by Yourself!](https://ropensci.org/commcalls/2017-03-07/), with Jenny Bryan, JD Long, and Scott Chamberlain. +If you're asking for R help, reporting a bug, or requesting a new feature, +you're more likely to succeed if you include a good reproducible example, a "reprex". +There's a [well-documented package](https://reprex.tidyverse.org/) for that including a video, +and an rOpenSci Community Call - [How to Ask Questions so they get Answered! Possibly by Yourself!](https://ropensci.org/commcalls/2017-03-07/), with Jenny Bryan, JD Long, and Scott Chamberlain. ### How to contribute? @@ -83,4 +124,4 @@ If you’re asking for R help, reporting a bug, or requesting a new feature, you * **Subscribe to our [Newsletter](https://news.ropensci.org/)** * **Ask or answer questions**. Participate in discussions in the [forum](https://discuss.ropensci.org/), on GitHub or on Slack * **Try a 2-hour [remote co-working session](https://www.cscce.org/2020/02/04/online-co-working-partnerships-are-community-of-practice-in-action/)** with someone in our Slack #co-working channel -* **Seek community feedback on your package ideas in the “Packages” category in our [forum](https://discuss.ropensci.org/c/packages)** +* **Seek community feedback on your package ideas in the "Packages" category in our [forum](https://discuss.ropensci.org/c/packages)** diff --git a/rsrc_commcalls.Rmd b/rsrc_commcalls.Rmd index ae141c5..e740505 100644 --- a/rsrc_commcalls.Rmd +++ b/rsrc_commcalls.Rmd @@ -1,21 +1,43 @@ ## Community Calls {#commcalls} -Our [Community Calls](https://ropensci.org/commcalls/) are an ideal way to get familiar with rOpenSci. They give you a feeling for how we blend rigorous expertise and recommendations with a friendly and safe way for all participants - presenters and attendees - to stretch themselves. They’re free and open for anyone to attend, and provide an opportunity to connect with rOpenSci community members around the world. Our session on [Maintaining an R package](https://ropensci.org/commcalls/2020-03-18/) had 90 participants from 18 countries! +Our [Community Calls](https://ropensci.org/commcalls/) are an ideal way to get familiar with rOpenSci. +They give you a feeling for how we blend rigorous expertise and recommendations with a friendly and safe way for all participants - presenters and attendees - to stretch themselves. +They're free and open for anyone to attend, and provide an opportunity to connect with rOpenSci community members around the world. +Our session on [Maintaining an R package](https://ropensci.org/commcalls/2020-03-18/) had 90 participants from 18 countries! -We’ve run more than 25 Community Calls since their start in 2015. Topics range widely and include [Reproducible research with R](https://ropensci.org/commcalls/2019-07-30/), [Testing](https://ropensci.org/commcalls/2019-12-05/), [Security for R](https://ropensci.org/commcalls/2019-05-07/), [How do you review code that accompanies a research project or paper?](https://ropensci.org/commcalls/2018-10-16/), [Involving multilingual communities](https://ropensci.org/commcalls/2019-06-28/), [Research applications of rOpenSci taxonomy and biodiversity tools](https://ropensci.org/commcalls/2019-03-27/), [Governance strategies for open source research software projects](https://ropensci.org/commcalls/2018-12-18/) and more! +We've run more than 25 Community Calls since their start in 2015. +Topics range widely and include [Reproducible research with R](https://ropensci.org/commcalls/2019-07-30/), +[Testing](https://ropensci.org/commcalls/2019-12-05/), +[Security for R](https://ropensci.org/commcalls/2019-05-07/), +[How do you review code that accompanies a research project or paper?](https://ropensci.org/commcalls/2018-10-16/), +[Involving multilingual communities](https://ropensci.org/commcalls/2019-06-28/), +[Research applications of rOpenSci taxonomy and biodiversity tools](https://ropensci.org/commcalls/2019-03-27/), +[Governance strategies for open source research software projects](https://ropensci.org/commcalls/2018-12-18/) and more! -> There’s nothing like hearing a lively technical banter of experts to pick up the vernacular that one can easily build upon. The first-hand tips and tricks, do’s and don’ts, personal anecdotes of what worked beautifully and what crashed terribly, offered by years of experience are yet unmatched in bringing newbies into speaking the community’s language. +> There's nothing like hearing a lively technical banter of experts to pick up the vernacular that one can easily build upon. +> The first-hand tips and tricks, do's and don'ts, personal anecdotes of what worked beautifully and what crashed terribly, +> offered by years of experience are yet unmatched in bringing newbies into speaking the community's language. >
> [Janani Ravi in "Maintaining an R Package - Community Call Summary"](https://ropensci.org/blog/2020/07/14/commcall-maintaining-pkg/) -These are not your usual webinar. Some calls might involve two to three speakers on a topic, some give an introduction to our tools in a specific research domain followed by several people presenting their use cases for those tools, and some are a moderated discussion among experts. We always leave at least 20 minutes for Q&A. We use collaborative note-taking allowing participants to share their own ideas or resources and to ask and answer questions. +These are not your usual webinar. +Some calls might involve two to three speakers on a topic, +some give an introduction to our tools in a specific research domain followed by several people presenting their use cases for those tools, +and some are a moderated discussion among experts. +We always leave at least 20 minutes for Q&A. +We use collaborative note-taking allowing participants to share their own ideas or resources and to ask and answer questions. -> This live shared document helps everyone ... formulate what they would like to say. It also gives people the option to participate without having to ... speak up on the call (thus reducing the barrier for people, especially newcomers, to ask questions). The document also gives an opportunity for anyone in the community to share their expertise ... +> This live shared document helps everyone ... formulate what they would like to say. +> It also gives people the option to participate without having to ... speak up on the call +> (thus reducing the barrier for people, especially newcomers, to ask questions). +> The document also gives an opportunity for anyone in the community to share their expertise ... >
> [Janani Ravi in "Maintaining an R Package - Community Call Summary"](https://ropensci.org/blog/2020/07/14/commcall-maintaining-pkg/) -Recordings of all past calls are [available online](https://vimeo.com/ropensci), with [closed captions](https://ropensci.org/blog/2020/07/15/subtitles/) (transcript of dialogue visible in text on video) for all calls in 2020 or later. +Recordings of all past calls are [available online](https://vimeo.com/ropensci), +with [closed captions](https://ropensci.org/blog/2020/07/15/subtitles/) +(transcript of dialogue visible in text on video) for all calls in 2020 or later.