Difference between revisions of "APB-Code review"
Jump to navigation
Jump to search
m (→Schedule) |
m |
||
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<div id="ABC"> | <div id="ABC"> | ||
| − | <div style="padding:5px; border: | + | <div style="padding:5px; border:4px solid #000000; background-color:#e19fa7; font-size:300%; font-weight:400; color: #000000; width:100%;"> |
Code and Design Review | Code and Design Review | ||
<div style="padding:5px; margin-top:20px; margin-bottom:10px; background-color:#e19fa7; font-size:30%; font-weight:200; color: #000000; "> | <div style="padding:5px; margin-top:20px; margin-bottom:10px; background-color:#e19fa7; font-size:30%; font-weight:200; color: #000000; "> | ||
| Line 46: | Line 46: | ||
| + | {{SLEEP}} | ||
{{Smallvspace}} | {{Smallvspace}} | ||
| Line 56: | Line 57: | ||
== Contents == | == Contents == | ||
| − | |||
We call our review sessions "Code reviews" for simplicity, however the purpose is not only to review '''code''', but also the '''design''', '''contents''', and '''form''' of the submitted material. | We call our review sessions "Code reviews" for simplicity, however the purpose is not only to review '''code''', but also the '''design''', '''contents''', and '''form''' of the submitted material. | ||
Code reviews are done for course credit '''of the reviewers'''. The units are already going to have been marked by the instructor before the review. Critical reviews are not going to affect that mark, there is no need to hold back on criticism to protect your peers for that reason. The best way to help your peers is to provide a high-quality review, with creative, constructive feedback. A well-prepared, thoughtful, knowledgeable review will be immensely valuable for your peers. And since '''you''' as the reviewer will be evaluated for credit, I hope that you will put your heart into it. | Code reviews are done for course credit '''of the reviewers'''. The units are already going to have been marked by the instructor before the review. Critical reviews are not going to affect that mark, there is no need to hold back on criticism to protect your peers for that reason. The best way to help your peers is to provide a high-quality review, with creative, constructive feedback. A well-prepared, thoughtful, knowledgeable review will be immensely valuable for your peers. And since '''you''' as the reviewer will be evaluated for credit, I hope that you will put your heart into it. | ||
| − | |||
| − | |||
| − | |||
; Principles: | ; Principles: | ||
| Line 79: | Line 76: | ||
<table> | <table> | ||
<tr class="sh"><td>Date</td><td>Title</td><td>Author</td><td>Reviewer 1</td><td>Reviewer 2</td><td>Reviewer 3</td><td>Reviewer 4</td></tr> | <tr class="sh"><td>Date</td><td>Title</td><td>Author</td><td>Reviewer 1</td><td>Reviewer 2</td><td>Reviewer 3</td><td>Reviewer 4</td></tr> | ||
| − | <tr class="s1"><td>October 10</td><td> | + | <tr class="s1"><td>October 10</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s2"><td>October 10</td><td> | + | <tr class="s2"><td>October 10</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s1"><td>October 10</td><td> | + | <tr class="s1"><td>October 10</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s2"><td>October 10</td><td> | + | <tr class="s2"><td>October 10</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| + | <tr class="s1"><td>October 10</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> | ||
</table> | </table> | ||
| Line 88: | Line 86: | ||
<table> | <table> | ||
<tr class="sh"><td>Date</td><td>Title</td><td>Author</td><td>Reviewer 1</td><td>Reviewer 2</td><td>Reviewer 3</td><td>Reviewer 4</td></tr> | <tr class="sh"><td>Date</td><td>Title</td><td>Author</td><td>Reviewer 1</td><td>Reviewer 2</td><td>Reviewer 3</td><td>Reviewer 4</td></tr> | ||
| − | <tr class="s1"><td>October 17</td><td>TBD</td><td>''' | + | <tr class="s1"><td>October 17</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s2"><td>October 17</td><td>TBD</td><td>''' | + | <tr class="s2"><td>October 17</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s1"><td>October 17</td><td>TBD</td><td>''' | + | <tr class="s1"><td>October 17</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s2"><td>October 17</td><td>TBD</td><td>''' | + | <tr class="s2"><td>October 17</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| + | <tr class="s1"><td>October 17</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> | ||
</table> | </table> | ||
| − | |||
<table> | <table> | ||
<tr class="sh"><td>Date</td><td>Title</td><td>Author</td><td>Reviewer 1</td><td>Reviewer 2</td><td>Reviewer 3</td><td>Reviewer 4</td></tr> | <tr class="sh"><td>Date</td><td>Title</td><td>Author</td><td>Reviewer 1</td><td>Reviewer 2</td><td>Reviewer 3</td><td>Reviewer 4</td></tr> | ||
| − | <tr class="s1"><td>October 24</td><td>TBD</td><td>''' | + | <tr class="s1"><td>October 24</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s2"><td>October 24</td><td>TBD</td><td>''' | + | <tr class="s2"><td>October 24</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s1"><td>October 24</td><td>TBD</td><td>''' | + | <tr class="s1"><td>October 24</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s2"><td>October 24</td><td>TBD</td><td>''' | + | <tr class="s2"><td>October 24</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s1"><td>October 24</td><td>TBD</td><td>''' | + | <tr class="s1"><td>October 24</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
</table> | </table> | ||
| − | |||
<table> | <table> | ||
<tr class="sh"><td>Date</td><td>Title</td><td>Author</td><td>Reviewer 1</td><td>Reviewer 2</td><td>Reviewer 3</td><td>Reviewer 4</td></tr> | <tr class="sh"><td>Date</td><td>Title</td><td>Author</td><td>Reviewer 1</td><td>Reviewer 2</td><td>Reviewer 3</td><td>Reviewer 4</td></tr> | ||
| − | <tr class="s1"><td>October 31</td><td>TBD</td><td>''' | + | <tr class="s1"><td>October 31</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s2"><td>October 31</td><td>TBD</td><td>''' | + | <tr class="s2"><td>October 31</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s1"><td>October 31</td><td>TBD</td><td>''' | + | <tr class="s1"><td>October 31</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| − | <tr class="s2"><td>October 31</td><td>TBD</td><td>''' | + | <tr class="s2"><td>October 31</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> |
| + | <tr class="s1"><td>October 31</td><td>TBD</td><td>'''NN'''</td><td>NN</td><td>NN</td><td>NN</td><td>NN</td></tr> | ||
</table> | </table> | ||
| Line 121: | Line 119: | ||
*The entire class is expected to have familiarized themselves with all submitted package before the first review, to establish context. | *The entire class is expected to have familiarized themselves with all submitted package before the first review, to establish context. | ||
*The entire class is expected to have installed and assessed the packages that are scheduled for review each review session, so that everyone can follow the discussion and contribute. | *The entire class is expected to have installed and assessed the packages that are scheduled for review each review session, so that everyone can follow the discussion and contribute. | ||
| − | *The designated reviewers of a package have worked through the material in detail, have made themselves knowledgeable about the context and background, and have prepared their review contributions (see below). I expect that reviewers will come to class very well prepared, and that they consider the unit with reference to the expectations set out in the [[ABC-Rubrics|evaluation rubrics for software design, code and documentation]]. | + | *The designated reviewers of a package have worked through the material in detail, have made themselves knowledgeable about the context and background, and have prepared their review contributions (see below). I expect that reviewers will come to class very well prepared, and that they consider the unit with reference to the expectations set out in the [[http://steipe.biochemistry.utoronto.ca/abc/index.php/ABC-Rubrics|evaluation rubrics for software design, code and documentation]]. |
{{Vspace}} | {{Vspace}} | ||
| Line 173: | Line 171: | ||
{{Vspace}} | {{Vspace}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
== Further reading, links and resources == | == Further reading, links and resources == | ||
*{{WP|Anti-pattern|'''Anti-pattern'''}} | *{{WP|Anti-pattern|'''Anti-pattern'''}} | ||
| Line 185: | Line 179: | ||
{{#pmid: 19957275}} | {{#pmid: 19957275}} | ||
--> | --> | ||
| + | == Notes == | ||
| + | <references /> | ||
{{Vspace}} | {{Vspace}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<div class="about"> | <div class="about"> | ||
| Line 216: | Line 200: | ||
*1.0 New unit | *1.0 New unit | ||
</div> | </div> | ||
| − | |||
<!-- included from "./data/ABC-unit_components.txt", section: "ABC-unit_footer" --> | <!-- included from "./data/ABC-unit_components.txt", section: "ABC-unit_footer" --> | ||
{{CC-BY}} | {{CC-BY}} | ||
| + | [[Category:Applied_Bioinformatics]] | ||
| + | {{INTEGRATOR}} | ||
| + | {{SLEEP}} | ||
| + | {{EVAL}} | ||
</div> | </div> | ||
<!-- [END] --> | <!-- [END] --> | ||
Latest revision as of 11:32, 24 September 2020
Code and Design Review
(Code review sessions - conduct and expectations)
Abstract:
This page explains conduct of and expectations for code and design reviews.
|
Objectives:
|
|
Deliverables:
Your participation as reviewers in the Code review sessions will be worth 8 marks in each panel for a total of 4 x 8 marks maximum.
This page is not currently being maintained since it is not part of active learning sections.
Contents
Contents
We call our review sessions "Code reviews" for simplicity, however the purpose is not only to review code, but also the design, contents, and form of the submitted material.
Code reviews are done for course credit of the reviewers. The units are already going to have been marked by the instructor before the review. Critical reviews are not going to affect that mark, there is no need to hold back on criticism to protect your peers for that reason. The best way to help your peers is to provide a high-quality review, with creative, constructive feedback. A well-prepared, thoughtful, knowledgeable review will be immensely valuable for your peers. And since you as the reviewer will be evaluated for credit, I hope that you will put your heart into it.
- Principles
- Units are not to be modified, until after the code review. Do not edit, upload, commit, push, merge or otherwise modify any material you have submitted for credit until after the review is done.
- We will use four weeks for reviews. We will schedule five to six reviews per class session, with four reviewers. This will give everyone approximately five minutes for their review contributions.
- Everyone will review four units.
- Typically everyone will participate in one review at every session, and never more than two.
Schedule
| Date | Title | Author | Reviewer 1 | Reviewer 2 | Reviewer 3 | Reviewer 4 |
| October 10 | TBD | NN | NN | NN | NN | NN |
| October 10 | TBD | NN | NN | NN | NN | NN |
| October 10 | TBD | NN | NN | NN | NN | NN |
| October 10 | TBD | NN | NN | NN | NN | NN |
| October 10 | TBD | NN | NN | NN | NN | NN |
| Date | Title | Author | Reviewer 1 | Reviewer 2 | Reviewer 3 | Reviewer 4 |
| October 17 | TBD | NN | NN | NN | NN | NN |
| October 17 | TBD | NN | NN | NN | NN | NN |
| October 17 | TBD | NN | NN | NN | NN | NN |
| October 17 | TBD | NN | NN | NN | NN | NN |
| October 17 | TBD | NN | NN | NN | NN | NN |
| Date | Title | Author | Reviewer 1 | Reviewer 2 | Reviewer 3 | Reviewer 4 |
| October 24 | TBD | NN | NN | NN | NN | NN |
| October 24 | TBD | NN | NN | NN | NN | NN |
| October 24 | TBD | NN | NN | NN | NN | NN |
| October 24 | TBD | NN | NN | NN | NN | NN |
| October 24 | TBD | NN | NN | NN | NN | NN |
| Date | Title | Author | Reviewer 1 | Reviewer 2 | Reviewer 3 | Reviewer 4 |
| October 31 | TBD | NN | NN | NN | NN | NN |
| October 31 | TBD | NN | NN | NN | NN | NN |
| October 31 | TBD | NN | NN | NN | NN | NN |
| October 31 | TBD | NN | NN | NN | NN | NN |
| October 31 | TBD | NN | NN | NN | NN | NN |
Preparation
- The entire class is expected to have familiarized themselves with all submitted package before the first review, to establish context.
- The entire class is expected to have installed and assessed the packages that are scheduled for review each review session, so that everyone can follow the discussion and contribute.
- The designated reviewers of a package have worked through the material in detail, have made themselves knowledgeable about the context and background, and have prepared their review contributions (see below). I expect that reviewers will come to class very well prepared, and that they consider the unit with reference to the expectations set out in the [rubrics for software design, code and documentation].
During the review
Reviews proceed in three rounds: first, the lead reviewers ask their most important prepared questions in turn; second, the reviewers lead a more general round of discussion; finally the discusion is opened to the entire class. Each review will take approximaetley twenty minutes.
- Code will not be presented by the author (unfortunately we don't have enough time), but the reviewers may ask some initial questions for clarification. Other than that, familiartity with the unit is assumed.
- Reviewers will comment on issues focussing on importance, visual appeal and utility of the package. Ideally, reviewers will make specific suggestions for improvement but it is better to point out a weakness, even if you don't quite know how to address it, than to remain silent. Once it is pointed out, others may have useful ideas. Of course, if you note particular strengths of the unit, that is also welcome.
- Issues for discussion could include:
- Suggestions to make the objectives of the tool more clear.
- Improvements to integrating the unit with existing packagesothers (but without introducing unnecessary dependencies).
- Constructive critique of software design decisions.
- Improvements to examples to better illustrate the concepts.
- Addressing any unstated assumptions.
- Identifying significant dependencies that could become obstacles to refactoring.
- Flagging, where the material lacks rigour or is factully incorrect.
- Improvements to form and layout.
- Identifying code that does not conform to coding style.
- Identifying code that exemplifies poor practice ("anti-patterns", design smell", "code smell").
- Improvements to comments;
- Improvements to visuals;
- Flagging where the sample code might not be robust against faulty input.
- Flagging where the sample code might not be safe against overwriting user data.
- Any other issues ...
- During the review, reviewers take notes of responses and comments.
Overall, be mindful that code review is a sensitive social issue, and that the primary objective is not to point out errors, but to improve the entire "team".
After the review
- After the review, on the same day, the reviewers summarize their issues and proposals on the "Talk" page of the package synopsis on the Student Wiki (briefly, in point form);
- Once all suggestions are in, the unit author begins revisions.
- It is not mandatory that the revisions follow the reviewers' suggestions. Authors need to consider comments carefully, but apply their own best judgement. In the end, the reviewers are responsible for their reviews, but the author is responsible for their package.
A final note
I hope that in your career you will find yourself in a workplace where peer-review is a regular part of your activities. This may contribute tremendously to better outcomes, more transparent and more meaningful work, and more cohesive teams. When that time comes, your skills as reviewers will be evaluated implicitly, although perhaps neither you, your supervisor, nor your project lead might realize this. You will be prepared.
Further reading, links and resources
Urs Enzler's "Clean Code Cheatsheet" (at planetgeek.ch) Oriented towards OO developers, but expresses sound principles that apply by analogy.
Notes
About ...
Author:
- Boris Steipe <boris.steipe@utoronto.ca>
Created:
- 2017-10-13
Modified:
- 2018-09-12
Version:
- 1.1
Version history:
- 1.1 2018 updates
- 1.0 New unit
This copyrighted material is licensed under a Creative Commons Attribution 4.0 International License. Follow the link to learn more.
This page is not currently being maintained since it is not part of active learning sections.
