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

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

(Review Request)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Review Request  ==
 
== 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 [[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.   
+
The '''Review Request''' page helps open source project contributors and committers work together to review contributor changes.  Typically, a contributor has forked one or more repositories 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]] to '''Ask for Review'''. This 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.
 
When the reviewing developer opens the page, the page will help to locate the commit.
Line 7: Line 7:
 
== Asking for Review  ==
 
== 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.<br><br> [[Image:AskForReview1.jpg]]<br><br> 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:<br><br> [[Image:AskForReview2.jpg]]<br><br> 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.
+
When you want someone to review your commit, open the [[Orion/Documentation/User Guide/Reference/Git Commit page|Git Commit page]] for the commit and click the <b>Ask for Review</b> button.
  
== Using Review Request Page  ==
+
[[Image:AskForReview1.jpg]]
  
Review Request page offers you various options based on the state of your workspace.  
+
Here you can enter the Orion user name of the person you wish to review your contribution.  The reviewer will receive an email containing your name, the commit message, and a link to the '''Review Request''' page.  If you wish to paste the link into a chat window or bug report, you can click the <b>More</b> button on the slideout.
  
=== You have no repositories in your workspace  ===
+
[[Image:AskForReview2.jpg]]
  
If you have no repositories in the workspace, you will see the following view:
+
From this dialog you can copy the link, or press <b>Submit</b> to send the email.
  
[[Image:ReviewRequest1.jpg]]<br><br> 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: <br><br> [[Image:ReviewRequest5.jpg]]<br><br> 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.<br>
+
== Using the Review Request Page  ==
  
<br>
+
The main purpose of the Review Request page is to help the committer locate the commit that needs review.  The page will have various options depending on which repositories you are connected to.
  
=== You have repositories in your workspace, but none of them has matching remote ===
+
=== No repositories  ===
  
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:
+
If you have not connected to any repositories, you will see the following view:
<br>
+
<br> [[Image:ReviewRequest7.jpg]]<br><br> 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.<br>
+
  
<br>
+
[[Image:ReviewRequest1.jpg]]
  
=== You have a repository with matching remote, but the commit is not there  ===
+
Click the '''Clone Repository''' button to create a new clone of the repository. When the clone is complete and the page is refreshed, you will see the following view:
  
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:<br><br> [[Image:ReviewRequest6.jpg]]<br>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.<br>
+
[[Image:ReviewRequest5.jpg]]
  
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.
+
The desired commit is shown in the new section. You can open the commit or repository. You can also preview the commit in the '''Open Commit''' tooltip.
 +
 
 +
=== You have repositories, but not the contributor's remote ===
 +
 
 +
Perhaps you have some repositories, but none of them has a remote matching the one from the Review Request URL.
 +
 
 +
[[Image:ReviewRequest7.jpg]]
 +
 
 +
You may attach the remote to one of your existing 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 page will refresh. You will see the commit in the '''The commit can be found...''' section.
 +
 
 +
=== You have a repository with a matching remote, but the commit is not there  ===
 +
 
 +
If you have a repository with the desired remote in your workspace, but the commit is not there, you will see the following:
 +
 
 +
[[Image: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.
 +
 
 +
The more repositories you have in your workspace, the more entries will be shown on the Review Request page.
 +
 
 +
== Reviewing the Code ==
 +
Once a commit has been located on the Review Request page, the committer will typically open the [[Orion/Documentation/User Guide/Reference/Git Commit page|Git Commit page]] to view the diffs.  From there, the committer may <b>Cherry-Pick</b> the commit, test it, and push it to the main development repository.
 +
 
 +
[[Category:Orion]]

Latest revision as of 11:46, 5 July 2017

Review Request

The Review Request page helps open source project contributors and committers work together to review contributor changes. Typically, a contributor has forked one or more repositories and proceeded to make some changes. When these changes are committed, the contributor can use the Git Commit page to Ask for Review. This 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, open the Git Commit page for the commit and click the Ask for Review button.

AskForReview1.jpg

Here you can enter the Orion user name of the person you wish to review your contribution. The reviewer will receive an email containing your name, the commit message, and a link to the Review Request page. If you wish to paste the link into a chat window or bug report, you can click the More button on the slideout.

AskForReview2.jpg

From this dialog you can copy the link, or press Submit to send the email.

Using the Review Request Page

The main purpose of the Review Request page is to help the committer locate the commit that needs review. The page will have various options depending on which repositories you are connected to.

No repositories

If you have not connected to any repositories, you will see the following view:

ReviewRequest1.jpg

Click the Clone Repository button to create a new clone of the repository. When the clone is complete and the 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 the commit in the Open Commit tooltip.

You have repositories, but not the contributor's remote

Perhaps you have some repositories, but none of them has a remote matching the one from the Review Request URL.

ReviewRequest7.jpg

You may attach the remote to one of your existing 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 page will refresh. You will see the commit in the The commit can be found... section.

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

If you have a repository with the desired remote in your workspace, but the commit is not there, you will see the following:

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.

The more repositories you have in your workspace, the more entries will be shown on the Review Request page.

Reviewing the Code

Once a commit has been located on the Review Request page, the committer will typically open the Git Commit page to view the diffs. From there, the committer may Cherry-Pick the commit, test it, and push it to the main development repository.

Back to the top