Diff for "WorkingWithReviews"

Not logged in - Log In / Register

Differences between revisions 3 and 4
Revision 3 as of 2010-01-21 10:42:27
Size: 5940
Editor: henninge
Comment:
Revision 4 as of 2010-01-28 18:44:37
Size: 6196
Editor: bac
Comment:
Deletions are marked like this. Additions are marked like this.
Line 36: Line 36:
You may only merge once the reviewer has approved the modification. You may only merge once the reviewer has approved the modification and you have made all changes that were requested. If you want to make a case why a specific suggestion should not be followed then you must bring it up with the reviewer and not merge until agreement has been reached and documented in the merge proposal.

This page covers the process for effectively dealing with code and design reviews.

Overview

During the development of a feature from concept to rollout there are a number of reviews that occur. The first review process is the SpecificationProcess where the concept is examined and refined into a plan. This plan is eventually signed off by the appropriate manager. Some time later, a coder will start to implement it. When they are about to do this a DesignPhoneCall takes place, which is a verbal review of the design of the planned implementation. Finally, once the code is complete the PreMergeReviews process takes place.

Specification reviews

Please see SpecificationProcess for the specification workflow.

Design reviews

Design reviews are conducted by a DesignPhoneCall between a coder and a reviewer. The review aims to ensure that the resulting code will have few or no structural problems, which makes review of the code easier and faster.

Code reviews

Once your code is complete, it must go through the PreMergeReviews process to be accepted into the central trunk. See https://help.launchpad.net/Code/Review to learn about Launchpad Merge Proposals.

Handling review responses

The story starts with you making a Launchpad Merge Proposal into launchpad-devel or launchpad-db-devel. From there the branch is queued for review at https://code.launchpad.net/launchpad/+activereviews . You may ask an on-call reviewer in #launchpad-reviews to review the branch outside of the queue.

Once your reviewer has had time to go over the modifications, he will reply to the proposal with a description of areas or items that need to be fixed, modified or improved in your code. He may also write special recommendations, commend you for your code quality, or ask questions if unclear on domain specifics or obscure functionality.

You must respond to each individual suggestion and question made by your reviewer; one of the main dangers with reviews is wasting the reviewer's time by ignoring or forgetting to deal with some specific issue, and the reviewer can't be expected to go through and ensure each item was dealt with --- please make an effort to ensure you respond accurately to reviews.

One or more review cycles will be necessary per-modification; the number of cycles will depend on the amount of code changed, the increasing familiarity of the reviewer with your code, and of course the quality of the code produced.

You may only merge once the reviewer has approved the modification and you have made all changes that were requested. If you want to make a case why a specific suggestion should not be followed then you must bring it up with the reviewer and not merge until agreement has been reached and documented in the merge proposal.

Small branches are faster to review than large ones - a branch that is twice as big as another takes more than twice as long to review. Please try to keep branches small and focused.

Review tags

During the review process, you should keep your branch tags updated correctly in

The tags are meant to give better feedback of where the review stands, and will allow the review status page to show the branches clearly.

The tags may assume one of the following strings:

  • needs review
    • The initial status.
  • needs fixing
    • The branch has been reviewed and requires some small changes.
  • resubmit
    • The branch has been reviewed and it has fundamental problems that require substantial changes after a new implementation call.

  • rejected
    • The focus/intent of the branch is not appropiate for merging.
  • approved (with a comment)
    • The branch can be merged after the reviewer's comments are addressed.

  • approved
    • The branch can be merged.

Also, if your branch was reviewed by a mentored reviewer (a.k.a. a mentat), you require another review. before you can merge.

                                 .--------------------.
                                 |                    |
                                 v                    |
                         .--------------.      .--------------.
            START --->   | needs-review | ---> | needs-fixing |
                         '--------------'      '--------------'
                                /|\
 .-----------------------.     / | \     .----------.
 | approved-with-comment | <--'  |  '--> | approved |
 '-----------------------'       |       '----------'
                                 |
                           .----------.
                           | rejected |
                           '----------'

Dealing with Conflicts

If, after a successful review process, you submit your code to PQM only to find conflict you need to resolve the conflicts:

  1. Merge rocketfuel onto your reviewed branch, resolve the conflict, push, and submit another merge request.

If, in the process of resolving conflicts, you make non-trivial changes to the code, you should consider having those changes reviewed before attempting to merge them.

The merge message

Each merge message must include an item indicating who the reviewer of the change was. This is the general form of a commit message.

  • [r|rs=foo,bar][ui=none|baz|rs][bug=nnnnnn] describe the change.
    'r' means review, 'rs' means rubberstamp. One or ore reviewers must follow the r or rs. The 'ui' token states who reviewed the ui; none may be used when there is no ui, and rs may be used when there is ui, but it needs review after merging.

  • [testfix] is a special leading token required to land a branch when trunk branch is broken and future merges must supply a fix.

Make it so

When you are ready to submit your branch to pqm for merging, use the following command (from RocketFuelSetup):

bzr pqm-submit -m '[r=reviewer] description of changes'

WorkingWithReviews (last edited 2011-02-17 20:01:28 by lifeless)