Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Orion/Documentation/User Guide/Reference/Review Request page

< Orion‎ | Documentation‎ | User Guide
Revision as of 04:24, 23 August 2012 by Szymon.brandys.pl.ibm.com (Talk | contribs) (Review Request)

Review Request

Review Request is a new Orion's feature. It aims to help Orion's developers to review changes done by contributors. The workflow is very simple: after creating a commit contributor sends an email with notification from Orion. This email contains a link to the Review Request page. When developer opens it, he can see whether the commit is found or not in his workspace (and in which repository). If not, he is able to create a new clone of the repository, or fetch the existing repositories with the matching remote. See the detailed description of the workflow below.

Review Request was created while Google Summer of Code 2012.

Asking for Review

When you want to notify someone about commit you created, just open a Commit Explorer page about the change and click the button "Ask for Review".

AskForReview1.jpg

Now you can enter the Orion user name of the person you want to notify and he will receive an email containing your name, the commit message and URL to Review Request site. After clicking"More" on the slideout you can see the following popup:

AskForReview2.jpg

This window allows not only to send an email, but also to quickly copy an URL that you can later paste and send for example via IM. This URL opens a Review Request page that is described below.

Using Review Request Page

When you get an URL for Review Request after opening it you can see a couple of views depending of the state of your workspace. When nor commit neither copy of repository exists in you workspace you'll see the following view:

ReviewRequest1.jpg

To get the code you want to review simply click Clone Repository button and it will create new repository in the way known already from Orion. After finishing clone action the site will refresh you will see a view like this:

ReviewRequest5.jpg

The desired commit is shown in the new section. You can open the commit or repository. You can also preview commit in the tooltip. However, the "Create new repository" sections is still active and you can create more clones of the repository.
It also can happen that you have repositories in you workspace, which don't have the remote with reviewed commit attached. This is preview of such a simple case:

RewievRequest7.jpg

Then you have a chance to attach the new remote to the existing repository by clicking little icon on the right. You will be prompted to give the name for the new remote. Then Orion will automatically fetch the changes from the new attached remote and the site will refresh. You will be able to see reviewed commit in the section"The commit can be found..."

The last basic possibility is that you have a copy of the reviewed repository, but it does not contain the desired commit. Than Review Request page will allow you to fetch from the remote to this repository and after completing this task the commit will be available. Below there is illustration of this case. You have to possibilities to get the commit: fetch, and force fetch.

ReviewRequest6.jpg

Of course, the more repositories you have in your workspace, the more entries will be shown in each Review Request page section. However, the navigation doesn't change in such a case.

Back to the top