Creating a Snippet Review
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 code to be reviewed from the source to your system clipboard.
- Click Create snippet from the Create review menu in the Crucible toolbar.
- 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.
- Click Save to create the snippet review.
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.
- Click Reply on any comments to respond.
- 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
|
Last modified on Dec 2, 2016
Powered by Confluence and Scroll Viewport.