Updated on 2024-07-05 GMT+08:00

Review Comment Templates

To configure comment templates, you can choose Settings > Template Management > MR Comment Templates on the repository details page. You can create, edit, and delete a comment template, and customize template information such as Severity, Assign to, Review category, Module, and Description. When a repository member reviews a comment, you can select a review comment template. The template content is automatically applied to the merge request.

The settings take effect only for the repository configured.

All repository members can view this page. For details about whether a repository member has repository setting permissions, refer to the Permissions page.

Creating a Review Comment Template

Table 1 Parameters

Parameter

Description

Template name

(Mandatory) Name of the template to be created.

Configure the template as the default template

(Optional) If this parameter is selected, this template is used by default during comment reviewing.

Severity

(Optional) Classified into the following types based on problem severity: fatal, major, minor, and Suggestion.

Assign To

This parameter is optional.

  • If this parameter is set to empty:
    • When review comments are added to an MR, the comments are assigned to the MR creator by default.
    • When review comments are added to a file or Commit, the comments are assigned to nobody.
  • If this parameter is set to the MR creator or Commit author.
    • When review comments are added to an MR, the comments are assigned to the MR creator by default.
    • When review comments are added to a file or Commit, the comments are assigned to the Commit author by default.
  • Assign to specific person.
    • When review comments are added to an MR, the review comments are assigned to a specific person by default.
    • When review comments are added to a file or Commit, the review comments are assigned to a specific person by default.

Review category

This parameter is optional and is disabled by default. You need to Enable review comment categories and modules and configure the review comment category. For details, see Review comments.

Comment module

This parameter is optional and is disabled by default. You need to Enable review comment categories and modules and configure the review comment module. For details, see Review comments.

Description

This parameter is optional. Enter the description of the template. The description can be previewed.