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

Skip to end of metadata
Go to start of metadata

A Crucible project provides a way to group and manage related reviews – typically reviews that are all involved with the same software project. A Crucible 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. Click your user menu in the Crucible header, and choose Administration. You need to be logged in as an administrator to see this.
  2. Click Projects (under 'Project Settings').
  3. Click Add a new project (at the bottom of the list).
  4. Complete the fields in the 'Edit Project' page (described below).
  5. Click Save to create your new project.

    • Name – the plain language name as displayed in the Crucible interface.
    • Key – the project key used when giving reviews their unique code names. If you change the key for a project all open, and closed, reviews in the project are updated with the new key.
    • Default Repository – the repository that contains the source code for this project. This is the repository that will be searched by default when you add files to a review.
    • Store the contents of files in reviews – check to have the source files under review stored in the Crucible database, along with the comments and review data. This retains a copy of all the source files under review even if the repository is disconnected from Crucible. See Storing all revisions under review.
    Permission SchemePermission Scheme – the permission scheme applied to this project. (A permission scheme controls who can perform particular actions, for example, create a review.)
    • Enable the Moderator role – clear to have reviews run by the author only. See Enabling the moderator role.
    • Default Moderator – the user who will be set as the moderator for all new reviews created in the project. Leave this field blank to force the review's creator to choose a moderator. See Creating a review.
    Default Reviewers
    • By default, allow anyone to join reviews after creation – sets the default state of the Allow anyone to join checkbox on the 'Choosing reviewers' screen.
    •  Users – set the individual users to whom new reviews will be assigned by default.
    •  Groups – set the groups to which new reviews will be assigned by default.
    Allowed Review ParticipantsUse Users and Groups to restrict who can have a role (author/creator/moderator/reviewer) in this project's reviews. These users will be the only ones whose names appear when a review is assigned. Leave these fields blank to allow all users to have access.
    Review DurationDefault duration – the default length of time (in week days) for reviews in this project. If you leave the field blank, then no time restriction is applied.  Reviews that are overdue will show up in red on the reviewer's dashboards. Note that the review duration only affects the default due date that appears when creating a review. The review's creator or moderator can specify a different date if they wish.
    Default Review ObjectivesDefault Objectives – specify some text that will appear by default in the Review Objectives field of each new review. This text can be edited, as with any text in the Review Objectives text box. See Setting default review objectives.

Screenshot: The Edit Project Screen

  • No labels