Skip to content

Commit

Permalink
Merge pull request #73 from ropensci-org/v0.2.0
Browse files Browse the repository at this point in the history
V0.2.0
  • Loading branch information
steffilazerte committed Feb 1, 2022
2 parents 1a94fcb + 1f56444 commit 0da5b88
Show file tree
Hide file tree
Showing 30 changed files with 777 additions and 235 deletions.
50 changes: 30 additions & 20 deletions ACTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.."

---

Expand All @@ -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 youre prepared to participate
* [Read our Code of Conduct](#conduct) to ensure you're prepared to participate


### Communication channels {#channels}
Expand All @@ -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}
Expand All @@ -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 whats 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 whats 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 thats 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}
Expand All @@ -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 youre asking for R help, reporting a bug, or requesting a new feature, youre 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
Expand All @@ -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}
Expand All @@ -130,17 +132,25 @@ 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 its 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)
* [Request a co-maintainer for your package](#devguide)
* [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)
Expand All @@ -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 isnt addressed in the guide](#contributing)
* [Submit a typo fix or clarification or tell us whats 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)
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
14 changes: 10 additions & 4 deletions appendix.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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/)

Expand All @@ -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)
Expand All @@ -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)

Expand Down
Binary file added images/runiverse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/team-all.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
Expand Down
Loading

0 comments on commit 0da5b88

Please sign in to comment.