Terminology/Glossary

Code review takes many forms and has many names. For conciseness Crucible has adopted the following terms and meanings:

• Code Review - without prejudice to "Code Inspection", "Peer Review" or a myriad of other terms, Crucible uses the phrase "code review" for simplicity.
• Roles - Crucible uses the terms Author, Moderator, and Reviewer to describe the roles of review participants. In Crucible these terms have the following definitions:
  • Author - the person primarily responsible for acting on the outcomes of the review. In the vast majority of cases the Author will be the person who made the change under review.
  • Moderator - the person responsible for creating, approving the review, determining when reviewing is finished, summarizing the outcomes and closing the review. The Moderator defaults to the Creator.
  • Creator - the person who creates the review. In most cases this role will be undertaken by the Moderator.
  • Reviewer - a person assigned to review the change. Reviewers can make comments and indicate when they are complete. The Moderator and Author are implicitly considered reviewers.
  • User - a person using Crucible.
• States - a Crucible Review moves through the states: Draft ->Require Approval -> Approval -> Under Review -> Summarize -> Closed. The Require Approval state is only relevant when the Moderator is not the Creator. Reviews can be Re-Opened, i.e. moved from Summarize or Closed back to Under Review.
• Statement of Objective - is an optional text description of the review and any specific areas the reviewers should focus on.
• Comments - a comment is a short text note that is linked to a review, a revision/diff, source line, or other comment.
• Defect is a comment flagged as something that requires addressing and includes optional defect classifications.