Skip to content

Commit 6fc9943

Browse files
authored
Add block on mentored code review (#1240)
1 parent 7b81230 commit 6fc9943

File tree

1 file changed

+40
-0
lines changed
  • common-content/en/blocks/mentored-code-review

1 file changed

+40
-0
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
+++
2+
title="Mentored code review"
3+
4+
time = 20
5+
[objectives]
6+
1="Explain what a code reviewer is looking for in a PR."
7+
2="Describe elements of the GitHub code review interface."
8+
3="List ways someone writing code can make it easier to review."
9+
[build]
10+
render = "never"
11+
list = "local"
12+
publishResources = false
13+
14+
+++
15+
16+
Our learners get feedback on their work through code review.
17+
At work, colleagues review each others code to understand code, look for problems, and both share and learn better ways of doing things.
18+
19+
At {{<our-name>}} every learner should get code review on their work every week.
20+
21+
{{<note type="activity" title="Live Code Review">}}
22+
23+
Pair up a volunteer with one or more learners.
24+
25+
- The volunteer will review a pull request, and talk out loud about what they're looking for and doing.
26+
- The learner(s) will ask questions as they do.
27+
28+
{{</note>}}
29+
30+
<details>
31+
32+
<summary>Hints and tips</summary>
33+
34+
1. How did you understand what the goal of the PR is? Reading the title and description, looking at the coursework exercises, etc.
35+
2. The uses of the different tabs in a PR: Conversation, Commits, Files changed.
36+
3. What made a PR easy or hard to review:
37+
1. Where unrelated files/lines changed?
38+
2. Was code consistently formatted? Did indentation help or hurt understanding?
39+
4. How did you review the code? Did you read top-to-bottom? Did you jump around into and out-of functions? Did you look at tests? Did you clone the code locally and try running it?
40+
</details>

0 commit comments

Comments
 (0)