In this course, you will read your classmatesâ€™ code and give them comments about it. This document describes the whys and hows of the 6.005 code reviewing process.
You canâ€™t learn how to write without learning how to read â€“ and programming is no exception. Code reviewing is widely used in software development, both in industry and in open source projects. Some companies like Google have instituted review-before-commit as a required policy. You canâ€™t get a line of code into the Google source code repository unless another Google engineer has read it, given feedback about it, and signed off on it.
The benefits of code review in practice are several. Reviewing helps find bugs, in a way thatâ€™s complementary to other techniques (like static checking, testing, assertions, and reasoning). Reviewing uncovers code that is confusing, poorly documented, unsafe, or otherwise not ready for maintenance or future change. Reviewing also spreads knowledge through an organization, allowing developers to learn from each other by explicit feedback and by example. So code reviewing is not only a practically important skill that you will need in the real world, but also a learning opportunity.
What to Look For
Although you can make comments about anything you think is relevant, the primary goal of this class is to learn how to write code that is safe from bugs, easy to understand, and ready for change. Read the code with those principles in mind. Here are some concrete examples of problems to look for:
Bugs or potential bugs.
- Repetitive code (remember DRY, Donâ€™t Repeat Yourself).
- Disagreement between code and specification.
- Off-by-one errors.
- Global variables, and other too-large variable scopes.
- Optimistic, undefensive programming.
- Magic numbers.
Unclear, messy code.
- Bad variable or method names.
- Inconsistent indentation.
- Convoluted control flow (if and while statements) that could be simplified.
- Packing too much into one line of code, or too much into one method.
- Failing to comment obscure code.
- Having too many trivial comments that are simply redundant with the code.
- Variables used for more than one purpose.
Misunderstandings of Java.
- Misuse of
- Misuse of arrays or
Misusing (or failing to use) essential design concepts.
- Incomplete or incorrect specification for a method or class.
- Representation exposure for a data abstraction.
- Immutable datatypes that expose themselves to change.
- Invariants that arenâ€™t really invariant, or arenâ€™t even stated.
- Failure to implement the
Objectcontract correctly (
Positive comments are also a good thing. Donâ€™t be afraid to make comments about things you really like, for example:
Unusually elegant code.
We will be using a web-based code-reviewing system called Caesar, built here at MIT. Caesar is different from other code review tools (like Rietveld and Review Board) in several ways. Itâ€™s designed for reviewing whole programs, rather than changesets. It divides up a program into pieces, assigns them to multiple reviewers, and supports discussion-based reviewing with threaded comments and up and down votes. It automatically ignores widely-repeated code, like boilerplate or library code, in order to focus attention on code thatâ€™s worth the reviewersâ€™ time. With this system, you will read small bits of code written by several other students, and many other students will each read a small bit of yours.
Hereâ€™s how the process will typically go. Only problem set code will be reviewed. Team projects will not go through this process.
Beta due date: problem set is due.
Night of beta due date: submitted code is loaded into Caesar, and an announcement goes out by email to all reviewers that the reviewing process is open.
1-2 days after beta due date: you should visit Caesar, read the code that you were assigned, and make comments about them. For each piece of code you review, you can:
Make a comment
by clicking on a line of code or selecting a range of lines, and typing your comment.
Reply to another comment
by clicking on Reply. You can use this to clarify, expand on, or disagree with comments made by other reviewers.
Upvote a comment
by clicking the thumbs-up icon. Use this to agree with a comment made by another reviewer. Some comments in the system are made automatically by the Checkstyle style checker, and itâ€™s particularly useful for human reviewers to upvote or downvote its comments as appropriate.
Downvote a comment
by clicking on the thumbs-down icon. If youâ€™re disagreeing with a human, then itâ€™s polite and helpful to also Reply to explain why.
2 days after beta due date: code reviews are due.
On code review due date: course staff (TAs, LAs, instructors) review the reviews: upvoting, downvoting, replying, and commenting as appropriate, and looking for examples worth highlighting for the whole class.
Day after code review date: Look at your own code, and start revising your code for resubmission. Your final submission must address all the code reviews you received â€“ all the human comments plus all the automated checkstyle comments that are marked #important. You can address a code review either by changing the code to reflect the review or by including a source code comment in your code that explains why the code wasnâ€™t changed. If code reviews are unclear, you can discuss them with the reviewers by replying on the Caesar system, but you still must edit your own code in reaction to the review. A grader will check your final submission and deduct points if it hasnâ€™t addressed the code reviews. Needless to say, if you didnâ€™t get any code review comments â€“ which sometimes happens â€“ then you donâ€™t have to address any code review comments.
Privacy & Visibility
As a code author, you are anonymous. The system does not display your name with any of the code you wrote. Please donâ€™t put your full name, username, email address, or other identifying information in your source code. We try to strip out your name and username if it appears, but this process isnâ€™t perfect, especially since some of you have names that are pretty common in source code. Yes, Iâ€™m looking at you, little Bobby Tables.
As a reviewer, you are fully identified. The system displays your name and username with every review comment, reply, upvote, or downvote that you were responsible for. All registered users can see your name and what you wrote.
All reviewers, all code, and all comments are visible to registered users. The â€śall usersâ€ť link shows a list of all users, and each user has a profile page showing all the comments that they have made. A URL for a chunk of code or a review comment can be viewed by anybody logged in to Caesar, regardless of whether they were assigned as a reviewer for that particular chunk.
Caesar is accessible only to registered users. The system is not open to the net, nor is it indexed by Google. It is only visible to members or alumni of 6.005/6.170.
As a reviewer in Caesar, you have a reputation score, shown in parentheses after your name. You earn reputation points as follows:
- +1 pt for each upvote (by another user) of a comment you wrote
- +5 to +10 pts for writing a comment that is selected for highlighting
- +100 pts for passing 6.005/6.170.
If you start reviewing early, then you are more likely to get upvotes. If you write good comments, then you are more likely to get upvotes.
As a student in 6.005, your numeric reputation score has no effect whatsoever on your grade. Your participation grade does depend heavily on code reviewing, but the reputation score itself is irrelevant to that. Instead, we will base your participation grade on the quantity and quality of the actual reviewing that youâ€™ve done, by looking at the activity history on your profile page.
Be polite. Sarcasm, insults, and belittling words have no place in a code review. It doesnâ€™t matter whether youâ€™re talking about a person (a fellow reviewer or a code author) or about code. Donâ€™t call code â€śstupid,â€ť because that transfers all too easily to the author of the code, whether you meant it that way or not.
Be constructive. Donâ€™t just criticize, but be helpful: point the way toward solutions. â€śHopeless messâ€ť is not a constructive comment; â€śname the variables more descriptively, e.g. tmp1 is not a great nameâ€ť is much more constructive.
As a reviewer, you should downvote comments by others that are unconstructive or rude, and serious problems should be referred to the teaching staff.
As a code author, you should read your feedback carefully, and keep an open mind. Donâ€™t get defensive. If your reviewers â€“ who are MIT students and alums â€“ find your code confusing, then you should consider what this says about its clarity and maintainability in the real world. If you disagree with a comment, you can reply to it and engage the reviewer in a discussion, but keep in mind that this makes your identity visible.
FAQ for Reviewers
Does reviewing affect my grade? Yes, it contributes to your participation grade; see the Reputation section above.
Does my reviewing affect other peopleâ€™s grades? Not directly. Problem set grades do not take code reviewing into account, and other reviewersâ€™ participation grades are not affected by your upvotes or downvotes. But your reviewing will hopefully help other students become better programmers and acquire a better understanding of the course, and indirectly improve their grades.
How many classes do I need to review, and how much do I need to do on each one? The number you are assigned will depend on the size of the problem set, but will not exceed 10 classes. At a minimum, you must do at least one thing on each class assigned to you â€“ make a comment, reply to a comment, upvote, or downvote.
I donâ€™t feel like I know anything. How can I possibly review other peopleâ€™s code? You know more than you think you do. You can read for clarity, comment on places where the code is confusing, look for problems we read about or talked about in class, etc.
What if I canâ€™t find anything wrong? You can write a specific positive comment about something good.
What are these â€ścheckstyleâ€ť comments? They are generated automatically by a style checker called Checkstyle. Some of these comments might be wrong or inappropriate for the situation, so please use upvoting and downvoting to review Checkstyle too.
How much of the whole program do I have to try to understand? Caesar presents each class in isolation, and asks for comments just for that class. We donâ€™t expect you to look at anything else, or to spend time struggling to figure out whether itâ€™s correct. If you want to see the rest of the program, you can do so using the â€śview all codeâ€ť link. But again, itâ€™s not expected.
How can I find out who wrote this code? Code authors are anonymous until they reveal themselves â€“ e.g. by replying to a comment and stating that theyâ€™re the code author. You can write a comment asking a code author to reveal their identity, or contact you, if you wish. If there is a serious situation requiring the identity of the code author â€“ e.g., a potential case of plagiarism â€“ then bring it to the attention of the teaching staff.
FAQ for Code Authors
Can somebody use my code to cheat in the class? Since code reviewing doesnâ€™t start until after the deadline, this would be a problem only for students with extensions. Those students may not review code until after their extended deadline.
Is it OK to break my anonymity? Yes. Please let the reviewing process end before you get involved in any discussions of your code, but after that, if you want to join the discussion or directly contact one of your reviewers, you can do so.
Can I look at the reviews of my code while reviewing is still in progress? Yes, you can watch your reviews during the reviewing period, but donâ€™t jump in defensively. See Respect above.