Skip to main content
Jump to: navigation, search

Difference between revisions of "Orion/Documentation/User Guide/Reference/Review Request page"

m (You have repositories in your workspace, but none of them has matching remote)
(Review Request)
Line 1: Line 1:
 
== 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.
+
The '''Review Request''' page helps Orion contributors and committers work together to review changes done by contributors. Typically, a contributor has forked an Orion repository and proceeded to make some changes.  When these changes are committed, the contributor can use the [[Orion/Documentation/User Guide/Reference/Git Commit page|Git Commit page]] toolbar command to '''Ask for Review'''. This command will send an email containing a link to the '''Review Request''' page.
  
''Review Request was created while Google Summer of Code 2012.''
+
When the reviewing developer opens the page, the page will help to locate the commit.
  
 
== Asking for Review  ==
 
== Asking for Review  ==

Revision as of 11:51, 17 October 2012

Review Request

The Review Request page helps Orion contributors and committers work together to review changes done by contributors. Typically, a contributor has forked an Orion repository and proceeded to make some changes. When these changes are committed, the contributor can use the Git Commit page toolbar command to Ask for Review. This command will send an email containing a link to the Review Request page.

When the reviewing developer opens the page, the page will help to locate the commit.

Asking for Review

When you want someone to review your commit, just open the Commit page for the commit and click the Ask for Review button.

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 the Review Request page. After clicking More on the slideout you can see the following popup:

AskForReview2.jpg

This window allows not only to send the email, but also gives you the Review Request url that can be later sent via IM or pasted into Bugzilla. This url opens the Review Request page that is described below.

Using Review Request Page

Review Request page offers you various options based on the state of your workspace.

You have no repositories in your workspace

If you have no repositories in the workspace, you will see the following view:

ReviewRequest1.jpg

Click the Clone Repository button to create a new clone of the repository. When it is done and page is refreshed, you will see the following view:

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.


You have repositories in your workspace, but none of them has matching remote

You may also have some repositories in the workspace, but none of them has a remote matching the one from the Review Request url. Then, you will see:

ReviewRequest7.jpg

You may attach the remote to one of exisitng repositories. Click the Add Remote action and 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 see the commit in the The commit can be found... section.


You have a repository with matching remote, but the commit is not there

The last basic option is when you have a repository with the desired remote in your workspace, but the commit is not there. Then you will see:

ReviewRequest6.jpg
The Review Request page lets you fetch the remote and when it is done the commit will be shown in the The commit can be found... section.

Of course, the more repositories you have in your workspace, the more entries will be shown on the Review Request page. However, the navigation does not change in such a case.

Back to the top