Skip to content

Commit 0da5b88

Browse files
Merge pull request #73 from ropensci-org/v0.2.0
V0.2.0
2 parents 1a94fcb + 1f56444 commit 0da5b88

30 files changed

+777
-235
lines changed

ACTIONS.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ i.e. in the blog resource section, links to the blog guide link to #blogguide
1212

1313
### A note about text
1414

15-
Text in the **MAIN bullet** is the common action text, and ALSO the text to be inserted into Motivations Chapter.
15+
Text in the **MAIN bullet** is the "common" action text, and ALSO the text to be inserted into Motivations Chapter.
1616

17-
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.."
17+
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.."
1818

1919
---
2020

@@ -36,7 +36,7 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit
3636

3737
### Code of Conduct {#conduct}
3838

39-
* [Read our Code of Conduct](#conduct) to ensure youre prepared to participate
39+
* [Read our Code of Conduct](#conduct) to ensure you're prepared to participate
4040

4141

4242
### Communication channels {#channels}
@@ -46,12 +46,12 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit
4646
* [Subscribe to our Newsletter](#channels)
4747
* [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
4848
* [Ask or answer questions](#channels) in the forum or on [Slack](#channels-slack)
49-
* [Read or ask questions](#channels) in the Best Practices category in our forum or on [Slack](#channels-slack)
50-
* [Read or ask questions](#channels) in the Packages category in our forum or on [Slack](#channels-slack)
49+
* [Read or ask questions](#channels) in the "Best Practices" category in our forum or on [Slack](#channels-slack)
50+
* [Read or ask questions](#channels) in the "Packages" category in our forum or on [Slack](#channels-slack)
5151
* [Follow discussions](#channels) about statistical software peer review, best practices, and Q & A in the forum or on [Slack](#channels-slack)
5252
* [Support fellow community members](#channels) (e.g., by welcoming newcomers, giving credit, connecting members with people or resources)
5353
* [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).
54-
* [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.
54+
* [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.
5555
* [Browse the Jobs category](#channels) in our public forum or in **[Slack](#channels-slack)
5656

5757
### Community Calls {#commcalls}
@@ -61,30 +61,32 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit
6161
* [Recommend topics or speakers for Community Calls](#commcalls)
6262
* [Help organize a Community Call](#commcalls)
6363
* [Propose your idea for a Community Call summary post for our blog](#commcalls)
64-
* (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.
64+
* (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.
6565

6666

6767
### Blog {#blog}
6868

6969
* [Submit a correction](#blog)
70-
* (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.
70+
* (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).
7171
* [Read blog posts or tech notes](#blog)
72-
* [Read blog posts or tech notes](#blog), particularly those [tagged with Welcome](#blog-welcome)
73-
* [Read blog posts or tech notes](#blog), particularly those [tagged with Reviewer](#blog-reviewers)
74-
* [Read blog posts or tech notes](#blog), particularly those [tagged with Interviews](#blog-interviews)
72+
* [Read blog posts or tech notes](#blog), particularly those [tagged with "Welcome"](#blog-welcome)
73+
* [Read blog posts or tech notes](#blog), particularly those [tagged with "Reviewer"](#blog-reviewers)
74+
* [Read blog posts or tech notes](#blog), particularly those [tagged with "Interviews"](#blog-interviews)
7575
* [Read blog posts or tech notes](#blog) about specific rOpenSci packages, or about [creative use cases](#blog-usecases) for multiple rOpenSci packages
7676
* [Share posts with your network](#blog)
7777
* [Comment on a post to share your perspective or to ask a question](#blog)
7878
* **Write a blog post or tech note** (see both the [Blog](#blog) and the [Blog Guide](#blogguide))
79-
* (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.
79+
* (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.
8080

8181

8282
### Blog Guide {#blogguide}
8383

8484
* [Submit a correction](#blogguide)
85-
* (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).
85+
* (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).
8686
* **Write a blog post or tech note** (see both the [Blog](#blog) and the [Blog Guide](#blogguide))
87-
* (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.
87+
* (Chp3 text) Read about some [blog themes](#blog),
88+
browse the [Blog Guide](https://blogguide.ropensci.org/) to see what's involved,
89+
then contact our Community Manager our [contact form](https://ropensci.org/contact/) to discuss your idea.
8890

8991

9092
### Packages & Docs {#packages}
@@ -95,7 +97,7 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit
9597
* [Browse citations of rOpenSci packages](#packages) to find interesting applications
9698
* [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
9799
* [Write a post about using rOpenSci packages** on your own blog](#packages)
98-
* [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).
100+
* [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).
99101
* [Make a pull request](#packages)
100102
* To fix a bug
101103
* To add/fix examples
@@ -121,7 +123,7 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit
121123

122124
* [Label your issues](#issues)
123125
* [Include future plans for your package](#issues)
124-
* [Address a Help wanted issue](#issues)
126+
* [Address a "Help wanted" issue](#issues)
125127
* [Address any open issue](#issues). Explore open issues in rOpenSci packages and consider submitting a fix.
126128

127129
### The Dev Guide: Development, maintenance, and peer review of rOpenSci packages {#devguide}
@@ -130,17 +132,25 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit
130132
* [Read the Dev Guide](#devguide), especially the Reviewer Guide section
131133
* [Read the Dev Guide](#devguide), especially the CRAN Gotchas section
132134
* [Volunteer to review a package](#devguide)
133-
* [Submit your package for peer review](#devguide) after determining whether its in scope for rOpenSci
135+
* [Submit your package for peer review](#devguide) after determining whether it's in scope for rOpenSci
134136
* [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/).
135137
* [Ensure your package is easily citable](#devguide)
136138
* [Volunteer to maintain or co-maintain a package](#devguide)
137139
* [Request a co-maintainer for your package](#devguide)
138140
* [Publish a paper about your package](#devguide)
139141
* [Weigh in on tough technical issues on software review threads](#devguide)
140142
* [Submit a correction](#devguide)
141-
* (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
143+
* (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).
142144

143145

146+
### R-universe {#runiverse}
147+
* [Explore the R-universe](#runiverse)
148+
* [Explore the R-universe](#runiverse) and share your findings with colleagues
149+
* [Create your own R-universe](#runiverse)
150+
* [Create a community R-universe](#runiverse)
151+
* [Read/Contribute to the R-universe discussion](#runiverse)
152+
* [Report a bug in the R-universe](#runiverse)
153+
144154
### Statistical Software Peer Review Book {#statsreview}
145155

146156
* [Read our book](#statsreview)
@@ -150,5 +160,5 @@ Text in **SUB bullets** is either for Resources Chapter (noted Chp 3) with addit
150160

151161
### Community Contributing Guide {#contributing}
152162

153-
* [Contribute something that isnt addressed in the guide](#contributing)
154-
* [Submit a typo fix or clarification or tell us whats missing](#contributing)
163+
* [Contribute something that isn't addressed in the guide](#contributing)
164+
* [Submit a typo fix or clarification or tell us what's missing](#contributing)

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: contributing-guidance
22
Title: rOpenSci Community Contributing Guide
3-
Version: 0.1.0
3+
Version: 0.2.0
44
Authors@R:
55
c(person(given = "Stefanie",
66
family = "Butland",

appendix.Rmd

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
# Bibliography
44

5-
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.
5+
We're always standing on the shoulders of giants, some of whom don't think of themselves as giants.
6+
The following resources together influenced the ideas, approach, design, tone, and content of the rOpenSci Community Contributing Guide.
67

7-
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). Authors: https://github.com/github/opensource.guide#acknowledgments
8+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).
9+
Authors: https://github.com/github/opensource.guide#acknowledgments
810

911
- Dan Sholler, Igor Steinmacher, Denae Ford, Mara Averick, Mike Hoye, Greg Wilson (2019).
1012
[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
1820

1921
- RStudio. [RStudio Education](https://education.rstudio.com/)
2022

21-
- 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.
23+
- Nadia Eghbal (2020) [Working in Public: The Making and Maintenance of Open Source Software](https://press.stripe.com/#working-in-public).
24+
Stripe Press, San Francisco, CA.
2225

2326
- 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/)
2427

@@ -27,7 +30,7 @@ We're always standing on the shoulders of giants, some of whom don't think of th
2730

2831
# NEWS
2932

30-
## dev
33+
## 0.2.0
3134

3235
* Added NEWS chapter to appendix (#35)
3336
* 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
3841
* Fix Twitter link (#28)
3942
* Minor text re-wording (e.g., #34)
4043
* Switched to BS4 bookdown template
44+
* Added new resources: Help Wanted Page, Use Cases Page, R-universe, Social Co-working
45+
* Tweaked content
46+
* Updated staff and community manager information
4147

4248
## 0.1.0 (2020-08-25)
4349

images/runiverse.png

31.2 KB
Loading

images/team-all.png

1.01 MB
Loading

index.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ cover-image: images/contrib_guide_cover.png
1919

2020
# {-}
2121

22-
```{r, echo = FALSE, fig.cap="Cover illustration by Lydia Hill"}
22+
```{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."}
2323
knitr::include_graphics("images/contrib_guide_cover.png")
2424
citation <- "Stefanie Butland & Steffi LaZerte. (2020). rOpenSci Community Contributing Guide (Version v0.1.0). Zenodo. http://doi.org/10.5281/zenodo.4000532"
2525
```

0 commit comments

Comments
 (0)