Crucible 2.3 : Getting Started with Crucible
This page last changed on Aug 16, 2009 by edawson.
This page contains a basic overview of Crucible workflows, followed by a simple example showing a code review between two people. Crucible is a flexible application that caters for a wide range team sizes and work styles. You will need to know about the basic roles used in Crucible. Roles:
You will also need to understand how workflow is conducted in Crucible. This is configurable, but the most basic example follows. Crucible Workflow: Diagram: Workflow for One-to-One Reviews Next, we explore the workflow in a two-person code review in Crucible. Example Workflow: Two Participant Code ReviewThis is a simplified set of instructions for executing a one-to-one review involving two people. In this example, the code author wears "three hats", acting as review creator, moderator and code author, managing the review process as well as taking final responsibility for closing the review. The second person is the reviewer. ![]() 1. The Author Starts the ReviewTo begin, the code author sets up the review. There are a number of ways to do this, but for this example, the author starts from the FishEye Source view of the file he wants to review:
Screenshot: The Project Selection dialog
In the Project Selection dialog, you are prompted to choose a project for this review from the drop-down list. Once the selection is made, the author clicks the 'Create New Review' button. The Manage Files dialog opens. Screenshot: The Crucible Manage Files dialog In the Manage Files dialog, the author selects the source files they want to include in the review, by clicking the checkboxes next to the desired files. Once finished, the author clicks 'Done'. The Edit Review dialog appears, where the author can create and issue the review. Screenshot: Creating a review in the Edit Review dialog In the Edit Review dialog, the author enters information needed for the review. This includes entering a title and description for the review, selecting reviewers, a due date and the key for a related JIRA issue (if any). The project, moderator and author are pre-selected (for this example, the author should select himself as a moderator. When finished, the author clicks 'Save'. The review will now be created in a draft form. Screenshot: A newly created Crucible review The draft review opens. In the draft stage, the author can check the contents of the review files to ensure they are correct and put in any notes for reviewers as comments. During the draft phase, no notification email is sent out to reviewers. Once the author is finished with the draft phase, he clicks 'Start Review'. The review will now be started and notification email will go out to all participants. Crucible will now send out an email notification to all the participants. This lets them know that the review is under way and prompts them to take action, providing a URL for direct access to the review. (You can also subscribe to an RSS feed.) 2. The Reviewer Comments on the CodeThe reviewer will receive an email from Crucible (or an RSS feed update) with a link that they can follow to the review. Screenshot: A Crucible review notification email When the reviewer clicks the link in the notification email, the Crucible Review screen opens.
On the Crucible Review screen, the code changes under review are displayed. The reviewer clicks filenames to expand the code for in-line reviewing. As the reviewer reads the changes, they can simply click on any line to enter a comment there (multiple lines can be selected by clicking and dragging). The reviewer clicks the 'Post' button when each comment is finished.
When the reviewer has finished their code review work, they click the
3. The Author Responds to the CommentsDuring the review process, the author/moderator can also make contributions, responding to reviewer comments and making corrections. Screenshot: Comment threads in Crucible 4. The Author Closes the ReviewWhen all reviewers have Completed their reviews, the author/moderator is notified via email. The author/moderator clicks the link in the notification email, returning to the Review screen. The author/moderator will then add any final comments, then click the
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
![]() |
Document generated by Confluence on Jul 29, 2010 20:00 |