File tree Expand file tree Collapse file tree 1 file changed +18
-4
lines changed Expand file tree Collapse file tree 1 file changed +18
-4
lines changed Original file line number Diff line number Diff line change 1
1
# Mentoring Notes
2
2
3
- Mentoring notes are exercise-specific notes aimed to:
3
+ There are two types of mentoring notes:
4
+
5
+ 1 . Exercise-specific notes (shown for one specific exercise in the track)
6
+ 2 . Track-specific notes (shown for _ all_ exercises in the track)
7
+
8
+ The aim for these notes is to:
4
9
5
10
- Make mentoring an exercise easier for mentors
6
11
- Make mentoring an exercise consistent across mentors
7
12
8
13
## What do Mentoring Notes contain?
9
14
10
- Mentoring notes often contain:
15
+ Exercise-specific mentoring notes often contain:
11
16
12
17
- Examples of reasonable solutions
13
18
- Common suggestions/pitfalls
14
19
- Talking points
15
20
21
+ Track-specific mentoring notes often contain:
22
+
23
+ - Common suggestions/pitfalls (that apply to _ all_ exercises)
24
+ - Links to useful resources (like a style guide)
25
+
16
26
## How to add Mentoring Notes
17
27
18
- Mentoring notes are stored in the [ website-copy repo] [ website-copy ] within a ` tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md ` file.
19
- To add mentoring notes, submit a PR to add a file following the above file naming pattern.
28
+ Mentoring notes are stored in the [ website-copy repo] [ website-copy ] using the following file naming patterns:
29
+
30
+ - Exercise mentoring notes: ` tracks/<track-slug>/exercises/<exercise-slug>/mentoring.md `
31
+ - Track mentoring notes: ` tracks/<track-slug>/mentoring.md `
32
+
33
+ To add mentoring notes, submit a PR to add a file following the above file naming patterns.
20
34
21
35
### Why are Mentoring Notes not in the track repo?
22
36
You can’t perform that action at this time.
0 commit comments