Skip to content

Commit d83f011

Browse files
committed
start lesson contribution draft
1 parent 18e2abd commit d83f011

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

contributing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@ Soon, you will wonder why you ever bothered teaching alone.
7575

7676
Read more: {doc}`open-your-courses`
7777

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` .
7883

7984

8085
## Other types of contributions

lesson-contribution.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,30 @@ Also read {ref}`design` and {ref}`review`.
66

77
This document is work in progress on how to contribute to a CodeRefinery lesson.
88

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 theme and 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+
919
1. Find the lesson materials on GitHub
1020
2. Submit an issue describing the things you would like to fix / update / add
1121
3. Discuss with the team in the issue
1222
4. Work on your own fork and branch on the implementation
1323
4a. Add yourself as author to the citation.cff file
1424
5. Submit a draft Pull Request if you want early comments and discussion
15-
6. Submit a pull request to the lesson repository
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
1627
7. Remind the team in chat or via support@coderefinery.org if you do not get any comments or reviews within some days.
1728

29+
## Lesson preview
30+
31+
Preview lesson page by building it locally using Sphinx: XX
32+
33+
## Creating a CodeRefinery lesson
34+
35+
Creating your own lesson from scratch: XX

0 commit comments

Comments
 (0)