-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.qmd
242 lines (131 loc) · 7.98 KB
/
index.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
---
title: "How to contribute to open projects and communities"
author: "Yani Bellini Saibene"
format:
revealjs:
theme: [default, stilos.scss]
logo: ropensci.svg
slide-number: c/t
---
## Path for today
* What a contribution is for a open source project
* ...and for a community?
* Examples with rOpenSci
* How I can help people to contribute to my package?
## Contributions {.winter}
When you listen "Made a **contribution** to an open source project or community"...
...what comes to your mind?
# From a community perspective
We have some models of participation
## Pathway To Inclusion
### Six steps from "never heard of it" to "this is my thing"
::: {.incremental}
* **Awareness**: I've heard of this.
* **Understanding**: I understand what this is,and what it might be like for me to be involved.
* **Identification**: I can imagine myself doing this.
* **Access**: I can physically, logistically, and financially do this.
* **Belonging**: I feel like I fit in here.
* **Ownership**: I care enough to take responsibility for this.
:::
::: footer
[Pathway To Inclusion by Alex Bayley](https://www.harihareswara.net/posts/2022/the-pathway-to-inclusion-insight-from-alex-bayley/)
:::
## Pathway To Inclusion {.winter}
::: {.incremental}
* At what stage are you with rOpenSci?
* Can you give examples for other communities or projects that you are part and in what stage are you?
* How long did it take you to move from one state to another?
:::
::: footer
[Pathway To Inclusion by Alex Bayley](https://www.harihareswara.net/posts/2022/the-pathway-to-inclusion-insight-from-alex-bayley/)
:::
## CSCCE Community Participation Model
::: {.incremental}
* **Convey/Consume**: the CM convey information for members to consume independently of one another.
* **Contribute**: invited/facilitated by the CM. Enables members to discover the skills and interest of other. Made knowledge more visible.
* **Collaborate**: members collaborate with one another.
* **Co-create**: members work together within the community to co-create something they couldn't do before.
:::
::: footer
[CSCCE Community Participation Model](https://www.cscce.org/resources/cpm/)
:::
## CSCCE Community Participation Model {.winter}
* Where you would you put the Champions Program?
## CSCCE Community Participation Model
Champions program are usually in all the spectrum
Examples of champion-ing activities
::: {.incremental}
* **Convey**: they post on social media to spread the word more widely
* **Contribute**: they invite others to attend a event;
* **Collaborate**: they host a community call;
* **Co-create**: they run trainings or other activities for others in the community
:::
::: footer
[CSCCE Community Participation Model](https://www.cscce.org/resources/cpm/)
:::
## rOpenSci Examples
::: {.incremental}
* [rOpenSci Community Contributing Guide](https://contributing.ropensci.org): a guide to help people find ways to contribute to rOpenSci
* [rOpenSci Blog Guide](https://blogguide.ropensci.org): a guide to help people to write and edit blog post for rOpenSci Blog.
* [rOpenSci Packages: Development, Maintenance, and Peer Review](https://devguide.ropensci.org): guide for package authors, maintainers, reviewers and editors in rOpenSci software peer-review system
* [rOpenSci Statistical Software Peer Review](https://stats-devguide.ropensci.org): documentation of rOpenSci’s project on expanding software peer review to include statistical software.
:::
## rOpenSci Examples {.winter}
::: {.incremental}
* Have you participate in any of this options?
* Which one would you like to try?
* You can use many of this options as your outreach activity for the Champions Program.
* We would like to learn how we can improve this activities.
* Spread the word about this options to people in your communities.
:::
# How this concepts are useful for my package ?
## Convey
::: {.incremental}
* Create a comprehensive [README](https://blog.r-hub.io/2019/12/03/readmes/): clearly explains what your package does, how to install it, and how users can start using it. Include examples or use cases and (links to) any relevant information which might help users understand how your package can help them.
* [Pin your package repository to your profile](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile) so other people can find it quickly.
* [Create a universe on R-universe](https://ropensci.org/blog/2021/06/22/setup-runiverse/), simplify the installation of your package, and provide useful stats and information about it.
:::
## Convey
::: {.incremental}
* We recommend creating a **documentation website** for your package using pkgdown.
* Leverage platforms like Mastodon, LinkedIn, and R-specific forums such as [R-bloggers](https://www.r-bloggers.com/) and [R Weekly](https://rweekly.org/) to announce the release of your package.
* If you like to give talks, you can speak at an R User Group or [R-Ladies Chapter](https://www.meetup.com/pro/rladies/).
* Presenting your package at a **domain-specific conference** or at R-specific conferences.
* If your package fits in a [CRAN Task View](https://cran.r-project.org/web/views/) you can propose the addition.
:::
## Contribute / Collaborate
Make your repo contribution and collaboration friendly
::: {.incremental}
* Code of conduct (`CODE_OF_CONDUCT.md`): you can insert one with `use_code_of_conduct()` from the `usethis` package. The template comes from https://www.contributor-covenant.org.
* OSI License (`LICENSE.md`).
* Contributing guide (`CONTRIBUTING.md`): an easy way to insert a template for a contributing guide is the `use_tidy_contributing()` from the `usethis` package.
:::
## Contribute / Collaborate {.winter}
In groups use your package or the package we create in the other trainings and
* add a Code of Conduct.
* add a Contributing Guide.
Usethis helps: https://usethis.r-lib.org/reference/use_code_of_conduct.html
## Contributing guide
Personal preferences in a contributing guide include:
::: {.incremental}
* Style preferences?
* Infrastructure like roxygen2?
* Workflow preferences? Issue before a PR?
* Describe how you acknowledge contributions.
* A scope statement, like in the [skimr](https://github.com/ropensci/skimr/blob/main/.github/CONTRIBUTING.md#understanding-the-scope-of-skimr) package?
* We encourages contributing guides to include a [lifecycle statement clarifying visions and expectations](https://github.com/ecohealthalliance/fasterize/blob/main/CONTRIBUTING.md#roadmap) for the future development of your package.
:::
## Issue management
::: {.incremental}
* [Issue template(s)](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-templates=): help users fill better bug reports or feature requests.
* [Issue labelling](https://help.github.com/articles/helping-new-contributors-find-your-project-with-labels/): use labels such as “help wanted” and “good first issue” to help potential collaborators, including newbies, find your repo.
* [Pinning issues](https://docs.github.com/en/articles/pinning-an-issue-to-your-repository): You can pin up to 3 issues by repository that will then appear at the top of your issue tracker as nice issue cards. It can help advertise what your priorities are.
:::
## Further resources: Collaborate / Co-create.
::: {.incremental}
* Dev Guide section on [Working with collaborators](https://devguide.ropensci.org/maintenance_collaboration.html#workingcollaborators)
* Blog post [Marketing Ideas For Your Package](https://ropensci.org/blog/2024/03/07/package-marketing/)
* rOpenSci community call [Set Up Your Package to Foster a Community](https://ropensci.org/commcalls/apr2021-pkg-community/).
* For re-using kind and usual answers, consider GitHub’s [saved replies](https://docs.github.com/en/github/writing-on-github/working-with-saved-replies/using-saved-replies).
:::
# Time for Questions :-)