Skip to content

Commit 087e0c0

Browse files
authored
refactor: ♻️ updates from template-workshop (#252)
# Description Ran updates from template. ## Checklist - [x] Formatted Markdown - [x] Ran `just run-all`
1 parent 1f39e84 commit 087e0c0

File tree

11 files changed

+108
-100
lines changed

11 files changed

+108
-100
lines changed

.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
2-
_commit: 0.4.5
2+
_commit: 0.4.13
33
_src_path: gh:rostools/template-workshop
44
author_family_name: Johnston
55
author_given_name: Luke

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,16 @@ Please note that the project is released with a [Contributor Code of
109109
Conduct](CODE_OF_CONDUCT.md). By contributing to or being involved in
110110
this project, you agree to abide by its terms.
111111

112+
### Contributors
113+
114+
These are the people who have contributed by submitting changes through
115+
pull requests :tada:
116+
117+
[@lwjohnst86](https://github.com/lwjohnst86),
118+
[@signekb](https://github.com/signekb),
119+
[@K-Beicher](https://github.com/K-Beicher),
120+
[@martonvago](https://github.com/martonvago)
121+
112122
## Licensing
113123

114124
This project is licensed under the [CC-BY-4.0 License](LICENSE.md).

README.qmd

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ Please note that the project is released with a [Contributor Code of
100100
Conduct](CODE_OF_CONDUCT.md). By contributing to or being involved in
101101
this project, you agree to abide by its terms.
102102

103+
### Contributors
104+
105+
{{< include /includes/_contributors.qmd >}}
106+
103107
## Licensing
104108

105109
This project is licensed under the [CC-BY-4.0 License](LICENSE.md).
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
These are the people who have contributed by submitting changes through pull requests :tada:
22

3-
43
[\@lwjohnst86](https://github.com/lwjohnst86), [\@signekb](https://github.com/signekb), [\@K-Beicher](https://github.com/K-Beicher), [\@martonvago](https://github.com/martonvago)

includes/_reading-website.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
We try to be consistent with the way to present certain information in
2-
this website. Specifically, there are a few "syntax" type formatting of
3-
the text to know about:
2+
this website. Specifically, we follow some conventions that you should
3+
be aware of:
44

55
- Folder names always end with `/`, for example `data/` means the data
66
folder.

includes/_star-us.qmd

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
::: {.callout-tip appearance="minimal"}
2-
:star2: Do you find this workshop material useful? Please consider "starring"
3-
our [GitHub repository](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}})
4-
to show your appreciation! Starring the repository will save it to your
5-
list of saved repositories, so it's easy to find again later. As a plus, it
6-
helps give our project more visibility!
2+
## Do you find this workshop material useful?
3+
4+
If yes, please consider "starring" our [GitHub
5+
repository](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}).
6+
Starring the repository will save it to your list of saved repositories,
7+
so it's easy for you to find again later. As a plus, it helps give our
8+
project more visibility :star2:
79
:::

index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ to get started.
6060

6161
### Contributors
6262

63-
{{< include _contributors.qmd >}}
63+
{{< include /includes/_contributors.qmd >}}
6464

6565
## How the website is made
6666

justfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ build-readme:
5757

5858
# Generate a Quarto include file with the contributors
5959
build-contributors:
60-
sh ./tools/get-contributors.sh rostools/github-intro
60+
sh ./tools/get-contributors.sh rostools/github-intro > includes/_contributors.qmd
6161

6262
# Check for and apply updates from the template
6363
update-from-template:

overview/learning-design.qmd

Lines changed: 44 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@
44

55
This workshop is designed using the science of learning. Learning is
66
when new content gets incorporated into long-term storage in the brain
7-
and in a way that it can be later retrieved from storage to be used
8-
again. Some of the best ways to enable learning is to do "active
9-
learning" by engaging with the material, practicing retrieving what was
10-
just taught, repeatedly being exposed to and retrieve the content,
11-
linking the new information with what you already know, and explaining
12-
it to someone else.
7+
in a way that it can be later retrieved. Some of the best ways to enable
8+
learning is to do "active learning" by engaging with the material,
9+
practicing retrieving what was just covered, repeatedly being exposed to
10+
the content, linking the new information with what you already know, and
11+
explaining it to someone else.
1312

14-
We use a variety of activities to target the different pathways of
13+
We use a variety of activities to target the different "pathways" of
1514
learning. A big part of learning is being engaged in the *process* of
1615
learning, not just learning the content itself. So to help you be
1716
engaged in your own learning, we want to involve you in the reasons
18-
*why* we do the things we do. These are the things we do in this
19-
workshop that we've designed to enable optimal learning:
17+
*why* we do the things we do during this workshop.
18+
19+
Throughout the workshop, we use these practices to support learning:
2020

2121
- We have a clear learning goal with a strong narrative throughout the
2222
workshop that ties back to that goal. It's much easier to learn when
23-
you have a better idea of where you are going, where you are at, and
24-
what to expect along the way.
23+
you have a better idea of where you are going, where you are at in
24+
relation to the end goal, and what to expect along the way.
2525

2626
- The main activities are "code-alongs", where the teacher types on
2727
the computer and explains what it means while you type along. The
@@ -37,60 +37,54 @@ workshop that we've designed to enable optimal learning:
3737
your own, so you start to get a real sense of how to do it yourself.
3838

3939
- We have discussion activities to encourage linking the new
40-
information with what you already know and do in your work and how
41-
you can apply it. Since humans are social beings, we also tend to
42-
learn better when there is some social aspect to it. Explaining
43-
something to someone else is one of the best ways to learn! The
44-
quote "while we teach, we learn" from the Roman philosopher Seneca
45-
is true here.
40+
information with what you already know and do in your work as well
41+
as how you can apply it. Since humans are social beings, we also
42+
tend to learn better when there is some social aspect to it.
43+
Explaining something to someone else is one of the best ways to
44+
learn! The quote "while we teach, we learn" from the Roman
45+
philosopher Seneca is true here.
4646

4747
- We have minimal to no slides or lectures, as they are forms of
4848
information sharing with the lowest rates of learning. Instead we
49-
include reading tasks, so you can re-read things you may not
50-
understand, go at your pace, and take notes, all of which support
49+
include reading tasks, so you can go at your pace, re-read things
50+
you may not understand, and take notes, all of which support
5151
learning. To help reinforce what you just read, the teacher will
52-
briefly summarise and emphasise key points after you've read it,
53-
which is another form of repetition and targets another part of the
54-
brain (the auditory pathway).
52+
briefly summarise and emphasise key points after reading tasks, to
53+
repeat the main points and target another part of the brain (the
54+
auditory pathway).
5555

5656
- We include several breaks throughout the workshop to help you
5757
recharge and refocus. The brain is only able to effectively focus on
5858
one thing at a time in 30-50 minute blocks of time. That's why we
5959
mix together code-alongs, exercises, discussions, and reading to
60-
give your brain something different to focus on. But having an
61-
explicit break, even 5 minutes, is enough for the brain to better
62-
process and store what was covered.
60+
give your brain some variation. Having an explicit break, even 5
61+
minutes, is enough for the brain to better process and store what
62+
was covered.
6363

6464
- We put all the material online so that it is easy for you to go back
6565
to after the workshop, which builds the repetition and retrieval
66-
practice part of learning.
67-
68-
- Our brains can get easily distracted, which is completely normal! So
69-
if you get distracted during the workshop, you can go to the
70-
material online to quickly get caught up with where we are. We also
71-
make sure to follow the material on the website closely, so that it
72-
is easier for you to follow along.
66+
practice part of learning. Our brains get easily distracted, which
67+
is completely normal. So if you get distracted during the workshop,
68+
you can go to the material online to quickly get caught up with
69+
where we are. We also make sure to follow the material on the
70+
website closely, so that it is easier for you to follow along.
7371

7472
- Being in a safe and supportive environment puts the brain into a
75-
more relaxed state that also happens to be optimal for learning.
76-
Hence why we try to explicitly create that space, for example with
77-
the use of our Code of Conduct.
73+
more relaxed state that is optimal for learning. That's why we try
74+
to explicitly create that space, for example with the use of our
75+
Code of Conduct.
7876

79-
- Asking for help can be a hard thing to do, especially in settings
80-
where you are learning and might be confused or struggling with
81-
something being taught. You might feel vulnerable asking for help
82-
and showing that you don't know something. To help reduce these
83-
feelings and to create a safer space, we regularly get you to put up
84-
little origami hats (or stickies) to assess how everyone is doing.
85-
If you need help or are struggling with something, you put up the
86-
"help" hat (usually orange) and a helper will come to you as soon as
87-
they can. We often have several helpers, so that you can get help
88-
quickly. Putting up a little hat is a low effort way of asking for
89-
help. You don't need to raise your hand that everyone can see nor
90-
interrupt the teacher, and you can keep trying to follow along (or
91-
fix the issue) as you wait for a helper to come over. This means it
92-
will be easier for you to ask for help, which is what we want in a
93-
learning setting! :grin:
77+
- Asking for help can feel difficult, especially when you are learning
78+
and are unsure about something. To make it easier and feel safer, we
79+
use origami hats (or stickies) to show how everyone is doing. If you
80+
need help, you put up the "help" hat (usually orange) and a helper
81+
will come to you as soon as possible. If not, you can put up a "all
82+
good" hat (usually blue) to let us know you are following along.
83+
Since we often have several helpers, you usually won’t wait long.
84+
This simple system lets you ask for help without interrupting the
85+
teacher or drawing attention, so you can keep following along while
86+
you wait. Our goal is to make getting help easier and more
87+
comfortable.
9488

9589
Now you know a bit more about the thoughts behind how we've designed
9690
this workshop to really try to support and enable your learning! :tada:

pre-workshop/code-of-conduct.qmd

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,29 @@
22

33
# Code of conduct {#sec-code-of-conduct}
44

5-
Science thrives on diversity of thought and origin and we value the
5+
Science thrives on diversity of thought and origin. We value the
66
participation of every member of the scientific community and want all
7-
participants to have an enjoyable and fulfilling experience.
8-
Accordingly, all participants are expected to show respect and courtesy
9-
to other members throughout the workshop, in group work, and any
10-
activity associated with this workshop.
7+
learners to have an enjoyable and fulfilling experience. Accordingly,
8+
all learners are expected to show respect and courtesy to other members
9+
throughout the workshop, in group work, and any activity associated with
10+
this workshop.
1111

1212
To make clear what is expected, everyone taking part in this workshop,
13-
including teachers, helpers, organizers, and participants, is
14-
required to conform to the following Code of Conduct. Organizers will
15-
enforce this Code throughout events, but you may also contact us
16-
privately; all communication will be treated as confidential.
13+
including teachers, helpers, organizers, and learners, is required to
14+
conform to the following code of conduct. Organizers will enforce this
15+
code throughout the workshop, but you may also contact us privately; all
16+
communication will be treated as confidential.
17+
18+
The code of conduct applies to all spaces associated with this workshop
19+
including, but not limited to, group work, emails, and any online forums
20+
like GitHub. By participating, learners indicate their
21+
acceptance of the procedures by which the teachers and organizers
22+
resolves any code of conduct incidents.
23+
24+
## Expected behavior
1725

1826
We are dedicated to providing a welcoming and supportive environment for
19-
all people, regardless of background or identity. As such, we do not
27+
all people, regardless of background and identity. As such, we do not
2028
tolerate behaviour that is disrespectful to our teachers or learners or
2129
that excludes, intimidates, or causes discomfort to others. We do not
2230
tolerate discrimination or harassment based on characteristics that
@@ -27,36 +35,26 @@ veteran status, genetic information, religion or belief (or lack
2735
thereof), membership of a national minority, property, age, education,
2836
socio-economic status, technical choices, and experience level.
2937

30-
Everyone who participates in this workshop's activities is required to
31-
conform to this Code of Conduct. It applies to all spaces associated
32-
with this workshop including, but not limited to, group work, emails,
33-
and any online forums such as GitHub and Twitter. By participating,
34-
participants indicate their acceptance of the procedures by which the
35-
teachers and organizers resolves any Code of Conduct incidents.
36-
37-
## Expected behavior
38-
39-
All workshop participants are expected to show respect and courtesy to
40-
others. All interactions should be professional regardless of platform:
41-
either online or in-person. In order to foster a positive and
42-
professional learning environment we encourage the following kinds of
43-
behaviours in all interactions during this workshop:
38+
In order to foster a positive and professional learning environment, we
39+
encourage the following kinds of behaviours in all interactions during
40+
this workshop:
4441

45-
- Be kind and aware of your words
46-
- Use welcoming and inclusive language
42+
- Show kindness, courtesy and respect towards other workshop members
43+
- All interactions should be professional regardless of platform:
44+
online or in-person
45+
- Be aware of your words by using welcoming and inclusive language
4746
- Be respectful of different viewpoints and experiences
4847
- Gracefully accept constructive criticism
4948
- Focus on what is best for the workshop members and the community
5049
overall
51-
- Show courtesy and respect towards other workshop members
5250

5351
See the [four social
5452
rules](https://www.recurse.com/manual#sub-sec-social-rules) for further
5553
recommendations and details on proper behaviour.
5654

5755
## Unacceptable behavior
5856

59-
Examples of unacceptable behavior by participants include:
57+
Examples of unacceptable behavior by learners include:
6058

6159
- Written or verbal comments which have the effect of excluding people
6260
on the basis of membership of any specific group
@@ -78,19 +76,18 @@ Examples of unacceptable behavior by participants include:
7876

7977
## Consequences of unacceptable behavior
8078

81-
Participants who are asked, either in person or online, to stop any
82-
inappropriate behavior are expected to comply immediately. If a
83-
participant engages in behaviour that violates this Code of Conduct, the
84-
organizers, teachers, or helpers may take any action they deem
85-
appropriate, including warning the offender or expulsion from the
86-
workshop.
79+
Learners who are asked, either in person or online, to stop any
80+
inappropriate behavior are expected to comply immediately. If a learners
81+
engages in behaviour that violates this code of conduct, the organizers,
82+
teachers, or helpers may take any action they deem appropriate,
83+
including warning the offender or expulsion from the workshop.
8784

8885
Thank you for helping make this a welcoming, friendly workshop for all
8986
:smile:
9087

9188
::: {.callout-note appearance="default"}
92-
*Acknowledgements*: Large portions of this Code of Conduct were taken
93-
and modified from other Codes of Conduct, specifically [Software
89+
*Acknowledgements*: Large portions of this code of conduct were taken
90+
and modified from other codes of conduct, specifically [Software
9491
Carpentry](https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html)
9592
and
9693
[UofTCoders](https://github.com/UofTCoders/studyGroup/blob/gh-pages/codeOfConduct.md).

0 commit comments

Comments
 (0)