udacityCodeReviewerNotes/udacityCodeReviewerNotes.html at master · marciodo/udacityCodeReviewerNotes · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<!DOCTYPE html>
<html>
  <head>
    <title>Becoming a Udacity Code Reviewer Notes</title>
    <link rel="stylesheet" href="udacityCodeReviewerNotes.css">
    <meta charset="UTF-8">
  </head>
  <body>
    <h1>Notes on Becoming a Udacity Code Reviewer Course</h1>
    <div class="lesson">
      <h2>Revision Process</h2>
      <div class="concept">
        <div class="concept-title">
          <h3>1 - Read Read Read:</h3>
        </div>
        <div class="concept-description">
          <p>All project documentation from Udacity is available in
          <a href="https://github.com/udacity/Project-Descriptions-for-Review">
          this GitHub repository</a>. It's necessary to read this information
          to know all project specification.</p>
          <p>Next step is to read documentation sent from the student.</p>
        </div>
      </div>
      <div class="concept">
        <div class="concept-title">
          <h3>2 - Scan and Run:</h3>
        </div>
        <div class="concept-description">
          <p>First step is to scan student code to see how it is structured.</p>
          <p>Next step is to run the program to see if it works as expected.</p>
        </div>
      </div>
      <div class="concept">
        <div class="concept-title">
          <h3>3 - Provide Review:</h3>
        </div>
        <div class="concept-description">
          <p>Two ways of revision:</p>
          <ol>
            <li><b>Code review</b>: line-by-line commentary on the
            code, highlighting what about it is awesome and what can be
            improved.</li>
            <li><b>Project review</b>: use each project grading
            criteria and classify the project items where it Exceeds
            Specifications, Meets Specifications or Does Not Meet
            Specifications.</li>
          </ol>
        </div>
      </div>
    </div>
    <div class="lesson">
      <h2>SPECS ideas</h2>
      <div class="concept">
        <div class="concept-title">
          <h3>Simplify Code</h3>
        </div>
        <div class="concept-description">
          <p>It must be analyzed if the student code can be simplified
          somehow.</p>
        </div>
      </div>
      <div class="concept">
        <div class="concept-title">
          <h3>Practice Kindness</h3>
        </div>
        <div class="concept-description">
          <p>It's important to remember that a student took hours of his life
          watching the videos and preparing the projects. So, any effort to
          reduce frustration must be taken. One way to do so is to be kind with
          them.</p>
          <p>In each revision, the revisor must find some characteristics of
          the code to mark as "Awesome".</p>
        </div>
      </div>
      <div class="concept">
        <div class="concept-title">
          <h3>Explain Why &amp; With Examples</h3>
        </div>
        <div class="concept-description">
          <p>Each time a correction is done, it's necessary to explain why,
          preferably pointing to documentation like Google Guides or Python
          Library Docs, for example. The revisor can also write some code
          examples to the student. Gist is a good place to put these examples.
          </p>
        </div>
      </div>
      <div class="concept">
        <div class="concept-title">
          <h3>Connect Learners</h3>
        </div>
        <div class="concept-description">
          <p>Suggest to the student some useful source of knowledge like
          Tweeter, e-mail groups, etc.</p>
        </div>
      </div>
      <div class="concept">
        <div class="concept-title">
          <h3>Style Consistently</h3>
        </div>
        <div class="concept-description">
          <p>The student can use any style he wishes (eg: Python Style Guide),
          but the chosen style must be used throughout all the code.</p>
        </div>
      </div>
    </div>
    <div class="lesson">
      <h2>Revision Examples</h2>
      <div class="concept">
        <div class="concept-title">
          <h3>Stelar revision examples indicated by Kunal:</h3>
        </div>
        <div class="concept-description">
          <p>Use these two examples as a guide:</p>
          <ol>
            <li>
            <a href = "https://s3.amazonaws.com/udacity-hosted-downloads/gr001/reviews/Cheryl+Court+Review.pdf">
            Cheryl Court</a></li>
            <li>
            <a href = "https://s3.amazonaws.com/udacity-hosted-downloads/gr001/reviews/Raunaq+Sahni+Review.pdf">
            Raunaq Sahni</a></li>
          </ol>
        </div>
      </div>
    </div>
    <!--<div id="watermark">
      <img src = "http://www.chocolatemintsinajar.com/blog/wp-content/uploads/2010/06/IMG_0698.jpg" alt="Background image">
    </div>-->
  </body>
</html>