Documentation for Crucible 3.0.x. Documentation for other versions is available too.

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.

To create a snippet review:

  1. Copy the code to be reviewed from the source to your system clipboard.
  2. Click Create snippet from the Create review menu in the Crucible toolbar.
  3. Enter details for the snippet review:
    • Paste the code into the panel, where indicated.
    • Click on Click to add title near the top to enter a title for your review. If you don't specify a title, one will be automatically created for you.
    • Select a project from Project.
    • Select a programming language from Syntax Highlighting.
  4. Click Save to create the snippet review.

  5. Invite anyone that you want to participate in the snippet review by sending them the link to the review. The link is the review key, just above the review title. Anyone who is allowed to view the snippet is allowed to comment on it, and can close it.

  6. Click Reply on any comments to respond.
  7. Choose from the Tools menu to either close or delete the snippet review. Anyone can re-open, re-review or close snippet reviews, however, only the creator of a snippet review can delete it.

You can see your own snippets, or everyone's snippets, by choosing Reviews > Review  dashboard. See Searching Crucible for information about filtering snippet reviews.

Screenshots: Creating a Snippet Review (click to view larger images)

Step 1
Step 2
Step 3

  • No labels

7 Comments

  1. Jay Barra

    How do I invite someone to the review? I don't see that under the "Tools" dropdown?  Just e-mail them the link to the snippet?

    1. paulwatson

      Hi Jay. That's correct. Use the review key link, just above the review title.

  2. beeplogic

    How do I view a list of all snippets for a given project?

  3. Anonymous

    Is there a way to re-edit a snippet?

  4. Anonymous

    I was thinking of using this feature to review product requirements documents that are in .doc, .pdf, and .xls formats.  3 questions:

    1) Is there a limit to the number of characters in a snippet?

    2) Is there a better way (e.g., an atlassian plug-in) to review documents in those formats that would retain the formatting?

    3) What are the standard document formats that can be reviewed within Crucible other than .md documents?  Can you point me to a list somewhere?

  5. Anonymous

    I have been trying to use this feature, but there is no "close" option in the tools menu only "delete", "download", "print" and "add to favourites".

     

    1. Anonymous

      And I only have a "close" and no "delete". Probably a option set by whoever manages our the Crucible server.

 

 

 Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.