-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathCodeReviews.html
More file actions
239 lines (225 loc) · 14.4 KB
/
CodeReviews.html
File metadata and controls
239 lines (225 loc) · 14.4 KB
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Code Reviews — Programming in Python 7.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Persistence and Serialization" href="PersistanceAndSerialization.html" />
<link rel="prev" title="Coding Style and Linting" href="Pep8.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: #4b2e83" >
<a href="../index.html">
<img src="../_static/UWPCE_logo_full.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Topics in the Program</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../topics/01-setting_up/index.html">1. Setting up your Environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/02-basic_python/index.html">2. Basic Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/03-recursion_booleans/index.html">3. Booleans and Recursion</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/04-sequences_iteration/index.html">4. Sequences and Iteration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/05-text_handling/index.html">5. Basic Text Handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/06-exceptions/index.html">6. Exception Handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/07-unit_testing/index.html">7. Unit Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/08-dicts_sets/index.html">8. Dictionaries and Sets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/09-files/index.html">9. File Handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/10-modules_packages/index.html">10. Modules and Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/11-argument_passing/index.html">11. Advanced Argument Passing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/12-comprehensions/index.html">12. Comprehensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/13-intro_oo/index.html">13. Intro to Object Oriented Programing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/14-magic_methods/index.html">14. Properties and Magic Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/15-subclassing/index.html">15. Subclassing and Inheritance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/16-multiple_inheritance/index.html">16. Multiple Inheritance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/17-functional_programming/index.html">17. Introduction to Functional Programming</a></li>
<li class="toctree-l1"><a class="reference internal" href="../topics/18-advanced_testing/index.html">18. Advanced Testing</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../topics/99-extras/index.html">19. Extra Topics</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="Pep8.html">Coding Style and Linting</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Code Reviews</a></li>
<li class="toctree-l2"><a class="reference internal" href="PersistanceAndSerialization.html">Persistence and Serialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="Unicode.html">Unicode in Python</a></li>
<li class="toctree-l2"><a class="reference internal" href="IteratorsAndGenerators.html">Iterators and Generators</a></li>
<li class="toctree-l2"><a class="reference internal" href="Decorators.html">Decorators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../exercises/mailroom/mailroom-decorator.html">Mailroom – Decoratoring it</a></li>
<li class="toctree-l2"><a class="reference internal" href="ContextManagers.html">Context Managers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../exercises/context-managers-exercise.html">A Couple Handy Context Managers</a></li>
<li class="toctree-l2"><a class="reference internal" href="MetaProgramming.html">Metaprogramming</a></li>
<li class="toctree-l2"><a class="reference internal" href="../exercises/mailroom/mailroom-meta.html">Mailroom – metaprogramming it!</a></li>
<li class="toctree-l2"><a class="reference internal" href="Logging.html">Logging and the logging module</a></li>
<li class="toctree-l2"><a class="reference internal" href="Debugging.html">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="NoSQL.html">No SQL Databases</a></li>
<li class="toctree-l2"><a class="reference internal" href="GraphDatabases.html">Graph Databases</a></li>
<li class="toctree-l2"><a class="reference internal" href="Concurrency.html">Concurrent Programming</a></li>
<li class="toctree-l2"><a class="reference internal" href="Async.html">Asychronous Programming</a></li>
<li class="toctree-l2"><a class="reference internal" href="Coroutines.html">Notes on Coroutines</a></li>
<li class="toctree-l2"><a class="reference internal" href="ThreadingMultiprocessing.html">Threading and multiprocessing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../exercises/threaded_downloader.html">Threaded Web Scraper</a></li>
<li class="toctree-l2"><a class="reference internal" href="Profiling.html">Performance and Profiling</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #4b2e83" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Programming in Python</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li><a href="../topics/99-extras/index.html"><span class="section-number">19. </span>Extra Topics</a> »</li>
<li>Code Reviews</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/modules/CodeReviews.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
<a href="Pep8.html" class="btn btn-neutral float-left" title="Coding Style and Linting" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="PersistanceAndSerialization.html" class="btn btn-neutral float-right" title="Persistence and Serialization" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="code-reviews">
<span id="code-review"></span><h1>Code Reviews<a class="headerlink" href="#code-reviews" title="Permalink to this headline"></a></h1>
<div class="section" id="why-code-review">
<h2>Why code review<a class="headerlink" href="#why-code-review" title="Permalink to this headline"></a></h2>
<p>As professional developers, we need to always be learning and improving.</p>
<p>Code review is one of the best tools for this.</p>
<p>Code review is like having a personal tutor.</p>
<p>Code review helps more people to become familiar with the code.</p>
<p>Code review squishes bugs.</p>
<div class="section" id="getting-code-ready-for-review">
<h3>Getting code ready for review<a class="headerlink" href="#getting-code-ready-for-review" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Write tests - if there are tests, much easier to make changes on the fly during review</p></li>
<li><p>First draft is messy, refactor before code review</p></li>
<li><p>To get the most out of it, correct all that you can before review</p></li>
<li><p>Expect advice and corrections, and learn from them!</p></li>
<li><p>For this class, messy is okay. :-)</p></li>
</ul>
</div>
<div class="section" id="size-of-code">
<h3>Size of code<a class="headerlink" href="#size-of-code" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Code to review should be between 200 and 400 lines of code</p></li>
<li><p>Code can, and often will, be part of a bigger project</p></li>
<li><dl class="simple">
<dt>Code should be modular, so can examine one smallish piece during review:</dt><dd><ul>
<li><p>and be able to explain how it fits in the bigger project</p></li>
<li><p>and be able to explain what the smallish piece is doing in a few sentences</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</div>
<div class="section" id="when-why-to-review-code">
<h3>When/Why to review code<a class="headerlink" href="#when-why-to-review-code" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Think your code is ready for production</p></li>
<li><p>Have code working, but seems there is probably a better way</p></li>
<li><p>Totally Stuck</p></li>
<li><p>Having difficulty making it modular, can help you break large chunks into smaller chunks</p></li>
</ul>
</div>
<div class="section" id="what-to-look-for">
<h3>What to look for<a class="headerlink" href="#what-to-look-for" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>readability</p></li>
<li><p>‘pythonic’</p></li>
<li><p>tests</p></li>
<li><p>short functions/methods</p></li>
<li><p>anything not clear</p></li>
<li><p>logic issues</p></li>
</ul>
</div>
<div class="section" id="types-of-code-review">
<h3>Types of code review<a class="headerlink" href="#types-of-code-review" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>in person</p></li>
<li><p>in-line comments</p></li>
<li><p>using tools <a class="reference external" href="https://en.wikipedia.org/wiki/List_of_tools_for_code_review">https://en.wikipedia.org/wiki/List_of_tools_for_code_review</a></p></li>
</ul>
</div>
<div class="section" id="when-refactoring-or-doing-code-reviews-in-person">
<h3>When refactoring or doing code reviews in person<a class="headerlink" href="#when-refactoring-or-doing-code-reviews-in-person" title="Permalink to this headline"></a></h3>
<p>Write comments explaining what the code is doing (if unclear) and/or questions about the code</p>
<p>Then, if time permits you can jointly:</p>
<ul class="simple">
<li><p>work on making the code clearer</p></li>
<li><p>run tests after changes</p></li>
<li><p>goal is to make it clear enough to get rid of the comment(s) that were added</p></li>
</ul>
<p>Or do this yourself afterwards, as you would for written code reviews</p>
</div>
<div class="section" id="how-this-will-work-in-class">
<h3>How this will work in class<a class="headerlink" href="#how-this-will-work-in-class" title="Permalink to this headline"></a></h3>
<ul>
<li><p>Code can be pretty rough, no judging. :)</p></li>
<li><p>Person having code reviewed will send out link to code (a couple of days out, preferably)</p></li>
<li><p>At the beginning of the code review, reviewee will:</p>
<blockquote>
<div><ul class="simple">
<li><p>give a quick overview of the bigger picture</p></li>
<li><p>give a quick overview of the specific code we will look at</p></li>
</ul>
</div></blockquote>
</li>
<li><p>We will go over code together. Everyone is encouraged to make comments and ask questions.</p></li>
</ul>
<p>Feel free to ask your classmates in slack or on the mailing list about code you are writing.
This is why you have access to everyone’s code, to share and learn from each other.</p>
</div>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Pep8.html" class="btn btn-neutral float-left" title="Coding Style and Linting" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="PersistanceAndSerialization.html" class="btn btn-neutral float-right" title="Persistence and Serialization" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2020, University of Washington, Natasha Aleksandrova, Christopher Barker, Brian Dorsey, Cris Ewing, Christy Heaton, Jon Jacky, Maria McKinley, Andy Miles, Rick Riehle, Joseph Schilz, Joseph Sheedy, Hosung Song. Creative Commons Attribution-ShareAlike 4.0 license.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>