This documentation relates to an earlier version of Crucible.
View this page in the current documentation or visit the current documentation home.

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. Click the menu labelled with your user name in the the FishEye/Crucible header, and click the 'Administration' option. You will need to be logged in as an administrator to see this link. The FishEye/Crucible administration console will be displayed.
  2. Click 'Projects' link in the left menu.The 'Projects' page will be displayed showing all of the projects that you have set up in Crucible.
  3. Click the 'Create a New Project' link, at the bottom of the list of your existing projects.
  4. The 'Edit Project' page will be displayed. Complete the fields on this page:
    • 'Name' — Type a short phrase that describes your project.
    • 'Key' — Type a few characters to uniquely identify your project. This key must consist of alphabetic and/or numeric characters and hyphens only.
    • 'Default Repository' — 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.
      • 'Store the contents of files in reviews' — Tick this checkbox if you want to store the contents of files included in reviews, in the reviews themselves.
    • 'Permission Scheme' — Select the relevant permission scheme for this project. (A permission scheme controls who can perform particular actions, e.g. 'Create Review'.)
    • 'Enable the Moderator role for this project' — Tick this checkbox if you want enable the moderator role for this project.
      • 'Default Moderator' — 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.
    • 'By default, allow anyone to join reviews after creation' — Tick this checkbox, if you want to allow anyone to join reviews after creation. See Adding Reviewers.
    • (Optional) Under 'Default Reviewers', select the people to whom new reviews in this project will be assigned by default:
      • 'Users' — Type the name(s) of individual users to whom new reviews will be assigned by default.
      • 'Groups' — Type the name(s) of groups to whose members new reviews will be assigned by default.
    • (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:
      • 'Users' — Type the name(s) of individual users who will be eligible to be authors/creators/moderators/reviewers for reviews in this project*.
      • 'Groups' — 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.
    • 'Default duration in week days' — 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'.
    • 'Default Review Objectives' — Enter review objectives that will be applied to all new reviews. Click the 'Preview' button to preview the text entered in this field.
  5. Click the 'Save' button to create your new project.

Screenshot: The Create/Edit Project Screen

  • No labels