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:
- Copy the desired code from the source to your system clipboard.
- Click the 'Create Snippet' button in Crucible.
- Enter the details for the snippet review as follows:
- Paste the code from the system clipboard into the page. Snippet reviews can only contain one discrete file, or code snippet.
- Click the 'Click to add title' text. The field will become editable. Enter a title for your review. If you don't specify a title, one will be automatically created for you.
- Select a project from the 'Project' dropdown.
- Select a programming language to be used for syntax highlighting from the 'Syntax Highlighting' drop-down menus.
- Click the 'Save' button to create the snippet review. The review will be created.
- Invite anyone that you want to participate in the snippet review by sending them a link to the review. Everyone can see snippet reviews, anyone can comment on the review, and anyone can close it.
- Click the 'Reply' link on any comments to respond to the comments.
- Click the 'Tools' menu and click 'Close' to close the snippet review. The snippet review will be closed, i.e. no-one will be able to add new comments or reply to existing comments. Anyone can re-open, re-review or close snippet reviews. However, only the creator of a snippet review can delete it.
Screenshots: Creating a Snippet Review (click to view larger images)
|
|
|
Step 1
|
Step 2
|
Step 3
|
Attachments:




