This page last changed on May 26, 2010 by edawson.

This page explains how to create a simple code review using the Crucible 'Snippet Review' feature. Snippet Reviews are designed to be lightweight, ad-hoc code reviews with zero configuration, process or ceremony required.

On this page:

  1. Copy the desired code to your system clipboard from the source.
  2. Next to the 'Tools' button, click the 'Create Snippet' button in Crucible.
  3. Paste the code from the system clipboard into the page, click to enter a title, then select a default project and the programming language (for syntax highlighting) from the drop-down menus. Click 'Create'.
  4. The review will be instantly launched, you can now contact any colleagues you would like to specifically take part. Everyone can see snippet reviews, anyone can comment on the review, and anyone can close it. If you don't specify a title, one will be automatically created for you.
  5. Repond to the review comments, then close the review. Anyone can re-open, re-review or close snippet reviews.
  6. Review complete.

Snippet reviews can only contain one discrete file, or code snippet. Only the creator of a review can delete it.

Screenshot: Creating a Snippet Review

Screenshot: The Snippet Creation Screen

Screenshot: Composing a Snippet Review

Screenshot: Snippet Review with Comments


Document generated by Confluence on Jul 29, 2010 20:00