Applies to Collaborator 12.3, last modified on December 06, 2019

The Add to Review Wizard lets you add review materials to a new review or an already existing review.

To launch the wizard, use the Collaborator > Add materials main menu item, or the Add materials command in the toolbar of the Collaborator View in Visual Studio:

Note: Before using this command, we recommend that you configure SCM settings to let it connect to your source control repository. See also Source Control Integrations.

Steps

1. Select Review Materials

First, you should select what type of materials to upload. The number of available options would depend on what SCM configuration you have chosen as the default in the extension settings.

  • Add changelists/changesets/shelvesets - Upload changes that have been submitted to source control repository. The created review will contain all files that belong to the specified changelists, changesets or shelvesets along with the history of changes between revisions.

  • Add changed files - Upload pending changes (staged for, but not yet submitted to source control repository) from the current solution or from another location. The created review will contain the selected files along with the history of changes between the staged and the submitted revisions.

  • Add local files - Upload arbitrary local files. The created review will contain only the selected files without their revision history.

Click the image to enlarge it.

The next page lets you choose exactly which materials will be uploaded added to the review. This page looks different depending which materials you are adding to the review:

1.1 Uploading changelists/changesets/shelvesets

This page also depends on type of chosen SCM system and item.

  • For Git and Mercurial changelists: click Add and specify the ID of desired changelist.

    Click the image to enlarge it.

  • For RTC changesets: select the desired workspace and component, click Find and then select the desired changesets. Use Ctrl or Shift for multiple selection.

    Click the image to enlarge it.

  • For RTC work item changesets: select project area and perform one of the listed queries, click Find and then select the desired work item. All changesets that belong to the work item will be uploaded to review.

    Click the image to enlarge it.

  • For TFS changesets: Select the desired team project, specify changesets by their ID, range of IDs or date interval, click Find and then select the desired changesets. Use Ctrl or Shift for multiple selection.

    Click the image to enlarge it.

  • For TFS shselvesets: Select the desired shelveset from the list. Use Ctrl or Shift for multiple selection.

    Click the image to enlarge it.

When done, click Next to proceed.

1.2 Uploading changes

Click the image to enlarge it.

Select which of the modified files to upload.

When done, click Next to proceed.

1.3 Uploading local files

Select this command to upload arbitrary local files. This command does not check if these files are in a source control repository or not, and does not add information on differences to the review along with the files. Use it if you need to create a review for the files that are not in source control.

Click the image to enlarge it.

Click Add files and select the desired files in the ensuing Open File dialog. Specify the commit message and click Next.

2. Select Supporting Documents

On the second page, you may upload any other documents that supplement the uploaded files.

Click the image to enlarge it.

Click Add files and select the desired files in the ensuing Open File dialog. Specify the commit message and click Next.

3. Select Review

The third page of the Add to Review Wizard asks you to specify which review you would like to add materials to. You can create a new review and add the materials to the newly created review, or you can add the review materials to an existing review.

Click the image to enlarge it.

To add materials to a new review, select Create New Review, type a title to name your new review and select the review template.

To add materials to an existing review, select Add to Existing Review. Choose the review you would like to add the materials to. The list of possible reviews is created automatically by querying the server. This will generally be the same as the list of reviews in the Collaborator View.

Once you click Finish, all chosen review materials will be uploaded to the Collaborator server.

Note: Uploading files may take some time. Please be patient. During the upload, a progress dialog will appear.

When the upload is complete, the review will be displayed in the Review Screen.

See Also

Visual Studio Extension
Collaborator View
Review Screen
Code Viewer and Diff Viewer

Highlight search results