Skip to content
This repository was archived by the owner on Oct 26, 2020. It is now read-only.

Commit 5894e72

Browse files
committed
Update MENTORS.md
1 parent 59927b6 commit 5894e72

File tree

1 file changed

+30
-12
lines changed

1 file changed

+30
-12
lines changed

MENTORS.md

+30-12
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,42 @@
1-
Reviewing students homework
1+
# Guidelines
2+
3+
## Week Mapping
4+
5+
This repository has an unusual numbering system compared to the weeks we teach
6+
7+
- JavaScript Core 1 Week 1 -> `Week 1`
8+
- JavaScript Core 1 Week 2 -> `Week 2`
9+
- JavaScript Core 1 Week 3 -> `Week 3`
10+
- JavaScript Core 2 Week 1 -> `Week 4`
11+
- JavaScript Core 2 Week 2 -> `Week 5`
12+
- JavaScript Core 2 Week 3 -> `Week 6`
13+
- JavaScript Core 3 Week 1 -> `Week 7`
14+
- JavaScript Core 3 Week 2 -> `Week 8`
15+
- JavaScript Core 3 Week 3 -> `Week 9`
16+
17+
TO DO - Move each of these into their own folder corresponding to their module number and rename to be more sensible. This must be done while students are not working on the repo to avoid conflicts.
18+
19+
## Reviewing students homework
220

321
1. Go to https://github.com/CodeYourFuture/js-exercises/pulls
422
2. Find the PR opened by the student you are designated to help
523
3. If your student has not opened a PR, ask them to open a PR following the instructions in the README
624
4. Assign yourself to your student's PR so that other mentors know that your student has a reviewer
725
5. Go to the files tab in the PR and start a review. The review should contain:
826

9-
* Inline comments that:
10-
* Praise the student for showing initiative or creativity beyond the lesson
11-
* Point out mistakes or bad practises
12-
* Explain problems that could be caused by bad code
13-
* Ask why a solution might not work
14-
* Offer pointers or tips for a better solution
15-
* An overall comment (when you click the review changes button) that:
16-
* Praises the student for their effort/progress
17-
* Let's them know if you've asked them to make changes
18-
* Highlights any themes that need particular attention, if necessary
27+
- Inline comments that:
28+
- Praise the student for showing initiative or creativity beyond the lesson
29+
- Point out mistakes or bad practises
30+
- Explain problems that could be caused by bad code
31+
- Ask why a solution might not work
32+
- Offer pointers or tips for a better solution
33+
- An overall comment (when you click the review changes button) that:
34+
- Praises the student for their effort/progress
35+
- Let's them know if you've asked them to make changes
36+
- Highlights any themes that need particular attention, if necessary
1937

2038
6. Submit the review. As long as the student has attempted the homework, choose the option to accept changes so that they get a nice green tick (even if you are suggesting changes).
21-
7. Add a label for each set of exercises the student has completed (e.g. `week-1-class`, `week-1-homework`)
39+
7. Add a label to the PR saying `reviewed`
2240

2341
Example PR review: https://github.com/CodeYourFuture/js-exercises/pull/23#pullrequestreview-100326735
2442

0 commit comments

Comments
 (0)