You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,6 +75,11 @@ Soon, you will wonder why you ever bothered teaching alone.
75
75
76
76
Read more: {doc}`open-your-courses`
77
77
78
+
## Lesson contribution
79
+
80
+
All our lessons are hosted on GitHub. You can find the link to the GitHub repositories from the respective lesson page ([lesson links on our webpage](https://coderefinery.org/lessons/#lessons-that-we-teach-in-our-tools-workshops)) on the top right corner -> "Edit on GitHub".
81
+
82
+
Please refer to our lesson contribution page for guides and support: {ref}`contribute` .
This document is work in progress on how to contribute to a CodeRefinery lesson.
8
+
9
+
We use GitHub issues to communicate things that need to be updated, collect feedback and improvement suggestions.
10
+
Latest prior to every workshop we go through the issues and implement and resolve at least the urgent ones.
11
+
12
+
All our lesson materials are written in Markdown using our own [Sphinx lesson template](https://github.com/coderefinery/sphinx-lesson-template).
13
+
14
+
Improvements are done on branches either on the CodeRefinery repository or your own fork. The improvement suggestions are then submitted via Pull Requests.
15
+
For easier and faster review, please keep the pull requests topically small.
16
+
17
+
Steps to contribute to a CodeRefinery lesson:
18
+
19
+
1. Find the lesson materials on GitHub
20
+
2. Submit an issue describing the things you would like to fix / update / add
21
+
3. Discuss with the team in the issue
22
+
4. Work on your own fork and branch on the implementation
23
+
4a. Add yourself as author to the citation.cff file
24
+
5. Submit a draft Pull Request if you want early comments and discussion
25
+
6. Build the lesson locally to check the format
26
+
6. Submit a pull request to the lesson repository with coderefinery-team as reviewer
27
+
7. Remind the team in chat or via support@coderefinery.org if you do not get any comments or reviews within some days.
28
+
29
+
Some more hints and explanations can be found in our [Sphinx-lesson contribution quickstart](https://coderefinery.github.io/sphinx-lesson/contributing-to-a-lesson/).
30
+
31
+
## Lesson preview
32
+
33
+
Preview lesson page by building it locally using Sphinx, see also [Sphinx-lesson build](https://coderefinery.github.io/sphinx-lesson/building/).
34
+
35
+
## Creating a new CodeRefinery lesson
36
+
37
+
We have a self-explaining [Sphinx-lesson](https://coderefinery.github.io/sphinx-lesson/).
CodeRefinery is a training network around FAIR research software development. We usually offer two massive streamed interactive online workshops per year with instructors from within the team but also try to onboard new instructors from anywhere. You can find all information about how we do workshops in our [manuals](https://coderefinery.github.io/manuals). Many partners are also collaborate on additional workshops or hackathons. But CodeRefinery is not only workshops: It also is a community of people who enjoy helping others. In 2024 we also plan on doing more outreach, so if you are a social media guru or enjoy giving presentations in different forums, we would be delighted if you could help with that. Below you can find all links that are useful for anyone joining CodeRefinery in any capacity.
5
+
CodeRefinery is a training network around FAIR research software development. We usually offer two massive streamed interactive online workshops per year with instructors from within the team but also try to onboard new instructors from anywhere. You can find all information about how we do workshops in our [manuals](https://coderefinery.github.io/manuals). Many partners are also collaborate on additional workshops or hackathons. But CodeRefinery is not only workshops: It also is a community of people who enjoy helping others. We also want to do more outreach, so if you are a social media guru or enjoy giving presentations in different forums, we would be delighted if you could help with that. Below you can find all links that are useful for anyone joining the CodeRefinery team.
6
+
7
+
Anyone can be part of the team! If your organization officially wants to join:
8
+
- If your organization is in the Nordics, it can become a partner in the project.
9
+
- If your organization is outside the Nordics, it can become an observer in the project.
10
+
11
+
Read about the [benefits for partner organizations](https://github.com/coderefinery/reports-and-proposals/blob/main/phase-4-proposal/info_for_new_organizations.md)
12
+
6
13
7
14
## Links
8
15
9
16
### Connect
10
17
11
18
- Community chat - Zulip: [https://coderefinery.zulipchat.com](https://coderefinery.zulipchat.com)
12
19
- in addition to default channels, join at least: #coderefinery and #tools-workshop
13
-
- introduce yourself in #new-members
20
+
- introduce yourself in #greetings>introductions
14
21
- lots of optional channels, check them out!
15
22
- CodeRefinery team meeting notes, agenda and connection details: [https://hackmd.io/@coderefinery/team-meeting](https://hackmd.io/@coderefinery/team-meeting)
16
23
- Every Monday 14 CET in Zoom
17
24
- Everybody welcome
25
+
- CodeRefinery Ambassadors
26
+
- Network of people that like what we do and want to help spread the word and give us feedback
- Our website is on GitHub too, built with Zola -> [Website repository](https://github.com/coderefinery/coderefinery.org)
59
+
- Registration management is done via [NeIC Indico](https://indico.neic.no)
60
+
61
+
## Accounts
62
+
63
+
- Zulip
64
+
- GitHub
65
+
- HackMD
66
+
67
+
## Team responsibilities
68
+
69
+
According to project plan: Engagement in project activities.
70
+
It is up to you, which activities you would like to join. Individuals time is not tracked. But organizations are tracked, if original person month promise has been fulfilled.
71
+
72
+
## CodeRefinery activities you may want to join
41
73
42
-
##Become an instructor
74
+
### Instructor
43
75
44
-
We are always looking for new instructors for our main tools workshop happening twice a year in spring/autumn. For these workshops, we always have two instructors per topic and provide an instructor onboarding before the workshop when needed. We have gathered a lot of information and guides about "how to instructor at a CodeRefinery workshop", but the main aspects are summarized in our {doc}`instructor-intro`.
76
+
Our main tools workshop is happening twice a year in spring/autumn. For these workshops, we always have two instructors per topic and provide an instructor onboarding before the workshop when needed. We have gathered a lot of information and guides about "how to instructor at a CodeRefinery workshop", but the main aspects are summarized in our {doc}`instructor-intro`.
45
77
46
-
## Help us improve our materials
78
+
As an instructor you should bring or be willing to acquire the following tools and skills:
79
+
80
+
- Competence in FAIR software practises
81
+
- Interest in online streamed teaching to large audience
82
+
- Pedagogical skills
83
+
- Patience with supporting students and researchers without technical background about software tools and techniques
84
+
- Persons who like working with others since the teaching always happens in collaboration with others
85
+
- A decent camera and microphone for clear audio and video
86
+
87
+
Apart from instructors, our workshops also have a lot of other roles to fill: {ref}`roles`.
88
+
89
+
### Material contributor
47
90
48
91
Apart from lesson materials feedback and improvements, we also welcome any feedback and improvement suggestions on our manuals (these files here), installation instructions, webpage etc. Open tasks are summarized on the [CodeRefinery webpage](https://coderefinery.org/tasks/).
49
92
50
-
## As an organization
93
+
More info at {ref}`contribute`.
94
+
95
+
Help us make the lesson and other materials more clear, expand on examples, add exercises or new sections!
96
+
97
+
To help with material development, you will need or be ready to acquire the following tools and skills:
98
+
99
+
- GitHub account
100
+
- Skills in open source collaborative lesson development; fits well as learning by doing!
101
+
102
+
Apart from contributing new materials, contributions by others also need to be reviewed.
103
+
In order not to put pressure on the individuals we try to use the coderefinery-team as reviewers.
104
+
If you notice a pending review, please at least read and comment, even if you do not feel confident in merging.
105
+
106
+
### Organize other collaborative workshops
107
+
108
+
As mentioned above, CodeRefinery is a training collective. Apart from the main CodeRefinery workshop, partners may also choose to collaborate on other related training topics. The best way to get in touch is via Zulip chat.
51
109
52
-
There is many ways your organization can join or support a workshop:
110
+
### Support with outreach
53
111
54
-
```{figure} img/participate_organization.png
55
-
---
56
-
align: center
57
-
figwidth: 100%
58
-
---
112
+
It is incredibly hard to reach our target audience at the right time in their career. Please help!
113
+
We have social media channels that could always use some entertaining posts, a blog to share experiences, submit a talk or poster for a domain specific conference, or other places where our target audience may already be.
59
114
60
-
As a thank you we can add your organizations logo to the workshop page.
115
+
## Thank you!
61
116
62
-
Please contact: support@coderefinery.org
117
+
No matter what you choose to do, we are happy to have you!
118
+
CodeRefinery lives through its people and community!
0 commit comments