Skip to content

Commit e76b610

Browse files
lwasserkierisi
andcommitted
Fix: Edits from @kierSi
Co-authored-by: Jesse Mostipak <jesse.maegan@gmail.com>
1 parent 7fca20f commit e76b610

File tree

1 file changed

+30
-28
lines changed

1 file changed

+30
-28
lines changed

community/events/sprints.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@
1010
* Go through the pyOPenSci repo issues and ensure all relevant help-wanted / sprintable issues have labels and are on the project board.
1111
* Also ensure all issues on the project board have enough specific information for a new user to follow and complete the task needed to be done.
1212

13-
**During sprint**
13+
**During a sprint**
1414

1515
* label all newly submitted issues as sprint-event, sprint-name-year
16-
* merge small pr's that are clearly typo fixies, easy to review things
17-
* add contributors as contributors to the repo using the all contributors bot @all-contributors add @githubusername for code, review (for an issue use review for a pr use code, review ). Merge each all contributor pr individually and immediately to avoid merge conflicts
16+
* merge small PRs that are clearly typo fixes and other easy to review things
17+
* for PRs, add contributors to the repo using the all contributors bot, with the format `@all-contributors add @githubusername for code, review`
18+
* for an issue use review for a pr use code, review ).
19+
* merge each all contributor PR individually and immediately to avoid merge conflicts
1820

19-
**After Sprint**
21+
**After a Sprint**
2022

2123
:::
2224

@@ -28,7 +30,7 @@ There are three types of pyOpenSci sprint events:
2830

2931
1. **Community Sprint Events**: pyOpenSci hosts these at meetings it attends, such as PyCon US and the SciPy meeting.
3032
2. **Online Sprint Events**: pyOpenSci may hold its own sprint events online to encourage global contributions.
31-
3. **Community-Hosted Sprint Events**: Contributors and community members host pyOpenSci sprint events at meetings they attend.
33+
3. **Community-hosted Sprint Events**: Contributors and community members host pyOpenSci sprint events at meetings they attend.
3234

3335
During pyOpenSci sprints, contributors need tasks that are “sprintable.”
3436
Sprintable tasks are those that can be worked on and potentially completed (or
@@ -50,14 +52,14 @@ pyOpenSci uses a combination of GitHub project boards and user surveys to track
5052

5153
## Sprint Participant Motivations
5254

53-
Sprint participants are often motivated by different things:
55+
Sprint participants are often motivated by different things. Some come to:
5456

55-
* Some come to learn.
56-
* Some come to help and support a project they care about.
57-
* Some come to connect and build community.
57+
* learn
58+
* help and support a project they care about
59+
* connect and build community
5860

5961
pyOpenSci supports and empowers all of these motivations, with an emphasis on
60-
empowering contributors who are newer to contributing while greatly benefiting
62+
empowering contributors who are newer to contributing, while greatly benefiting
6163
from more experienced sprinters who can help move the organization forward.
6264

6365
### pyOpenSci sprints are accessible
@@ -85,7 +87,7 @@ that suit their skills and interests. They also are used to track new contributi
8587

8688
#### Help-Wanted Board
8789

88-
The pyOpenSci [**Help-Wanted project board**](https://github.com/orgs/pyOpenSci/projects/3) is a organization level GitHub project board that provides a central place where contributors can
90+
The pyOpenSci [**Help-Wanted project board**](https://github.com/orgs/pyOpenSci/projects/3) is an organization-level GitHub project board that provides a central place where contributors can
8991
find tasks that pyOpenSci needs help with. We have two automated workflows setup
9092
for the help-wanted project board:
9193

@@ -103,7 +105,7 @@ duration of a sprint. The pyOpenSci Help-Wanted board should be updated througho
103105
At the start of each year, the pyOpenSci community manager creates a new Sprint
104106
GitHub Project Board. Here is an example of the [2024 sprint project board](https://github.com/orgs/pyOpenSci/projects/12).
105107

106-
The board will have several columns or statuses each or which represents the name of a sprint event (example: pyconus-2024, scipy-2024, fall-festival-2024. This board is used to:
108+
The board will have several columns or statuses, each of which represents the name of a sprint event (example: pyconus-2024, scipy-2024, fall-festival-2024. This board is used to:
107109

108110
* **Track issues and pull requests opened during a sprint event**
109111
* **Organize and Monitor Tasks**: Keep track of the progress of tasks during the sprint, ensuring clarity on which issues are being worked on and by whom.
@@ -121,22 +123,22 @@ these items as they pop up, you are saving time spent in preparing for a sprint.
121123

122124
pyOpenSci uses the GitHub [help-wanted project board](https://github.com/orgs/pyOpenSci/projects/3)
123125
to keep track of tasks that volunteers can assist with. When you see an issue
124-
opened or if you open an issue yourself in any of our GitHub repositories within
126+
opened, or if you open an issue yourself in any of our GitHub repositories within
125127
our [pyOpenSci GitHub organization](https://www.github.com/pyopensci), always
126128
consider whether the issue is something that someone else could help us with.
127129

128130
If the issue is something that someone else in the community could do:
129131

130-
1. **Add a `help-wanted` Label**: Any issue or pull request with the `help-wanted`
132+
1. **Add a `help-wanted` Label**: any issue or pull request with the `help-wanted`
131133
label in our organization will be automatically added to our [pyOpenSci
132134
help-wanted board](https://github.com/orgs/pyOpenSci/projects/3).
133135

134-
2. **Add a `sprintable` Label (if applicable)**: If the task could be completed
136+
2. **Add a `sprintable` Label (if applicable)**: if the task could be completed
135137
during a sprint (meaning it is something that could be completed within an
136138
hour and up to a single day's worth of work), also add the label `sprintable`
137139
to the issue.
138140

139-
3. **Update the Status on the Project Board**: Once the issue has been added to
141+
3. **Update the Status on the Project Board**: once the issue has been added to
140142
the project board (it normally takes our CI workflow 30 seconds to a minute),
141143
update the status of the issue on the project board based on the type of skill
142144
needed.
@@ -148,13 +150,13 @@ The current types of tasks in our board include:
148150
* Beginner friendly / non technical
149151
* Dev Ops / GitHub actions (Continuous Integration)
150152
* Python programming
151-
* Website - css or ruby
153+
* Website - CSS or Ruby
152154

153155
:::{todo}
154156
we should add content review and sphinx as a status options for people that review our guidebook, run through tutorials etc.
155157
:::
156158

157-
:::{admonition} Make sure issues contain specific detailed information before adding them to a project board
159+
:::{admonition} Make sure issues contain specific, detailed information before adding them to a project board
158160
:class: important
159161

160162
If you are creating a new `help-wanted` issue, it's important to include as much detailed information in the issue as possible. Imagine someone else reading the issue (that is not you!). In reading the issue, does an outside contributor have:
@@ -166,7 +168,7 @@ If you are creating a new `help-wanted` issue, it's important to include as much
166168
When in doubt, more information is always better!
167169
:::
168170

169-
Labeling issues with `help-wanted` / `sprintable` throughout the year as they are opened will save significant preparation time when a Sprint event arises. It will also make it easier for fly-by contributors to find things to help us with throughout the year.
171+
Labeling issues with `help-wanted` / `sprintable` throughout the year as they are opened will save significant preparation time when a sprint event arises. It will also make it easier for fly-by contributors to find things to help us with throughout the year.
170172

171173
## Pre-Sprint Event Tasks
172174

@@ -193,7 +195,7 @@ Sprints are busy—please add as much specific information as you can to each is
193195

194196
### Ensure issue and pull request templates are up to date
195197

196-
A challenge of a successful sprint is that there will be many issues and pull requests to triage after the sprint. To keep track of new issues, during an event, every pyOpenSci GitHub repository should have a sprint issue template. Adding this template only needs to be completed once. However, if there is a new pyOpenSci Github repository (this rarely happens), make sure that repo has a sprint issue template.
198+
One challenge of a successful sprint is that there will be many issues and pull requests to triage after the sprint. To keep track of new issues during an event, every pyOpenSci GitHub repository should have a sprint issue template. Adding this template only needs to be completed once. However, if there is a new pyOpenSci Github repository (this rarely happens), make sure that repo has a sprint issue template.
197199

198200
The sprint template will auto-populate a `sprint-event` label on the issue or pull request when it is opened. We will then setup a GitHub action on the sprint project board for that year to auto-add any issue or pull request with the `sprint-event` label on it to the sprint project board.
199201

@@ -216,7 +218,7 @@ jesse will develop this process with whatever platform we end up using...
216218

217219
## Tasks during a sprint
218220

219-
Below are tasks that should occur during a spring event.
221+
Below are tasks that should occur during a sprint event.
220222

221223
### Collect participant information
222224

@@ -229,7 +231,7 @@ at the event via ______ **TODO insert how we do that here** _____ following the
229231

230232

231233
Metrics –
232-
Number of pr’s
234+
Number of PRs
233235
Number of issues
234236
Who contributed
235237
Where are the contributors from (country, place of work, other things??)
@@ -290,9 +292,9 @@ community, encouraging more participation and collaboration.
290292
### Issue and PR triage
291293
The biggest effort after a sprint will be triaging & addressing issues and pull requests that have been submitted during the sprint. This could take 1-2 weeks and up to a month depending on the scope of each change submitted.
292294

293-
If there are new issues with no associated pull request, you can
295+
If there are new issues with no associated pull request, you can:
294296

295-
1. Invite the issue author to submit a pr if the change seems reasonable and they are up to the task.
297+
1. Invite the issue author to submit a PR if the change seems reasonable and they are up to the task.
296298
2. If the issue is one that we agree should be addressed, then label the issue with `help-wanted` / `sprintable` so someone else can tackle it at our next pyOpenSci sprint.
297299

298300
Review each pull request submitted (or invite community members to review) and determine if the pull request looks good as is or requires changes following the standard GitHub review process.
@@ -310,19 +312,19 @@ steps to take:
310312
2. **Provide Feedback**: Include any relevant feedback or outcomes from the sprint. This could involve sharing metrics, such as the number of issues closed, pull requests merged, or any specific contributions that stood out.
311313

312314
3. **Invite Continued Engagement**:
313-
- **Newsletter**: Encourage participants to subscribe to the pyOpenSci newsletter
315+
- **Newsletter**: Encourage participants to subscribe to the [pyOpenSci newsletter](https://eepurl.com/iM7SOM)
314316
to stay updated on future events, news, and opportunities.
315-
- **LinkedIn**: Invite them to follow pyOpenSci on LinkedIn for professional updates
317+
- **LinkedIn**: Invite them to follow [pyOpenSci on LinkedIn](https://www.linkedin.com/company/pyopensci) for professional updates
316318
and community highlights.
317319
- **GitHub**: Remind them to continue following and contributing to pyOpenSci
318-
repositories on GitHub.
320+
[repositories on GitHub](https://github.com/pyopensci).
319321
- Discourse?
320322

321323
4. **Stay Connected**:
322324
- **Upcoming Events**: Inform participants about upcoming sprints, webinars,
323325
workshops, or any other events they might be interested in.
324326

325-
By thanking contributors you are helping to maintain the momentum generated during the sprint while also
327+
By thanking contributors you are helping to maintain the momentum generated during the sprint, while also
326328
fostering a sense of community, and encourage ongoing contributions to pyOpenSci projects.
327329

328330

0 commit comments

Comments
 (0)