This documentation applies to Crucible version 2.1.x. The latest Crucible documentation is available via this link.

Skip to end of metadata
Go to start of metadata

A Crucible project is a collection of reviews, typically reviews that all relate to the same application. In addition to providing a logical way of grouping reviews together, a project allows you to

  • define default moderators, authors and reviewers for the reviews in that project.
  • define which people are eligible to be reviewers for the reviews in that project.
  • use permission schemes to restrict who can perform particular actions (e.g. 'Create Review') in that project.

Every Crucible review belongs to a project. Each project has a name (e.g. ACME Development) and a key (e.g. ACME). The project key becomes the first part of that project's review keys, e.g. ACME-101, ACME-102, etc:

By default, Crucible contains one project. This default project has the key 'CR' and the name 'Default Project'.

To create a new project,

  1. From the 'Admin Menu', click 'Project List'.
  2. The 'Projects List' page will be displayed. Click the 'Create a New Project' link, which appears at the bottom of the list of existing projects.
  3. The 'Create Project' page will be displayed.
  4. In the 'Name' field, type a short phrase that describes your project.
  5. In the 'Key' field, type a few characters to uniquely identify your project. This key must consist of alphabetic and/or numeric characters and hyphens only.
  6. In the 'Default Repository' field, select the repository which contains source code relating to this project.
    (info) This repository is the one that will be searched by default when you add files to a review.
  7. In the 'Default Moderator' field, type the name of the person who will appear by default in the 'Moderator' field when you create a new review; or leave this field blank to force the review's creator to choose a moderator.
  8. (Optional) Under 'Default Reviewers', select the people to whom new reviews in this project will be assigned by default:
    • Select the 'Let allowed review participants join a review' check-box if you wish to determine the default for the 'Allow anyone to join' option on the 'Adding Reviewers' screen.
    • In the 'Users' field, type the name(s) of individual users to whom new reviews will be assigned by default.
    • In the 'Groups' field, type the name(s) of groups to whose members new reviews will be assigned by default.
  9. (Optional) Under Allowed Review Participants', select who will be allowed to have a role (i.e. be an author/creator/moderator/reviewer) in this project's reviews:
    • In the 'Users' field, type the name(s) of individual users who will be eligible to be authors/creators/moderators/reviewers for reviews in this project*.
    • In the 'Groups' field, type the name(s) of groups whose members will be eligible to be authors/creators/moderators/reviewers for reviews in this project*.
      * These users will be the only ones whose names appear when a review is assigned.
  10. In the 'Permission Scheme' drop-down list, select the relevant permission scheme for this project. (A permission scheme controls who can perform particular actions, e.g. 'Create Review'.)
  11. In the Review Duration section, you can enter a value for the number of working days that you want the review to run for. Simply type the number of days into the text entry field marked 'Default duration in week days' and click 'Save'.

Screenshot: The Create/Edit Project Screen

  • No labels