blob: 88837f02a4f7d1b3d74d6ddd5fbc64d529c47339 [file] [log] [blame]
Brian Silvermane4452c72013-04-14 22:23:50 -07001This file has some general information about how 971 does code reviews.
2
3We use Rietveld (<https://code.google.com/p/rietveld>) running in an app engine
4 app of ours. It is at <http://971code.appspot.com/>.
5
6[General Procedure]
7We try to code review all code before it gets checked in to svn. Code reviews
8 are also sometimes useful for getting feedback about documentation etc.
9First, somebody starts a code review and sends out emails to people asking them
10 to look. Then, other people look at it and make suggestions (in the form of
11 comments). The person who started the review (the owner of it) looks at the
12 comments and responds to them and/or changes their code and uploads new
13 versions for everybody to look at. Once all of the reviewers approve the code,
14 the owner checks it in and closes the code review (issue).
15
16[Reviewing]
17This is the section for people who have received emails about reviewing code
18 should look.
19The email that you receive will have a link to the issue (like
20 <http://971code.appspot.com/82001/>). Click on it to go to the issue page.
21 The most useful form of diff are the "Side-by-side diffs". Click the "View"
22 link in that column next to each file to look at it. After the first set of
23 comments, the "Delta from patch set" links are also helpful to see what got
24 changed so that you don't have to look at everything agin. While looking at
25 a diff, double-click on any line of code to leave a comment there. You can
26 also reply to existing comments. The web interface sometimes "eats" comments
27 right after you create/edit them. Refresh the page to fix that (don't just do
28 it again, or you'll end up with 2 identical comments). Once you are done
29 looking at all of the files and making comments, click the
30 "Publish+Mail Comments" link (at the top of each diff or on the left of the
31 main issue page) to send out your comments. You can also put general notes in
32 the "Message" box. If you think that it looks good, then put "LGTM" somewhere
33 in the message. The owner of the code review will keep looking at your
34 comments, making changes, and sending out more messages until it's finished.
35
36TODO(brians): add information about starting a review
37
38For more information about using Rietveld, see
39 <https://code.google.com/p/rietveld/wiki/CodeReviewHelp>.