Updated on 2025-08-25 GMT+08:00

Configuring a Sprint Plan

In a Scrum project, sprints can be used to manage and track versions.

Prerequisites

There is a Scrum project, in which you have permission to create sprints. For details about how to set permissions, see Managing Project Permissions.

Creating a Sprint

  1. Access the CodeArts Req homepage.
  2. Go to the project homepage and choose Work > Sprints.
  3. Click above the sprint list. In the Create Sprint dialog box, set related parameters.

    Table 1 Creating a Sprint

    Parameter

    Description

    Sprint Name

    Sprint name, which can contain a maximum of 60 characters, including letters, digits, periods (.), and underscores (_).

    Planned Duration

    Start time and end time of a sprint plan.

    Description

    Description of a sprint plan. The value can contain a maximum of 500 characters, including letters, digits, periods (.), and underscores (_).

  4. Click OK. The sprint is created successfully, and the sprint page is displayed.

    Figure 1 Sprints

    By default, the created sprints are displayed on the left in descending order of the creation time. You can click a sprint card on the left to switch to another sprint.

    The sprint page displays the sprint name, planned sprint time, sprint description, sprint statistics, and work items in the sprint.

Follow-up Operations

After operations in Creating a Sprint are complete, you can perform the following operations.

Figure 2 Work item list on the sprint page
Table 2 Managing a sprint

Operation

Description

Constraint and Restriction

Edit sprint

Click and select Edit in the upper right corner of the sprint card to edit the sprint name, planned time, and description.

You must have permission to edit sprints.

Change sprint status

  • Click in the upper right corner of a sprint card and click Start to change the sprint status from To Do to Doing.
  • For sprints in the Doing state:
    • Click in the upper right corner of the sprint card and click Set as To Do. The sprint state is changed from Doing to To Do.
    • Click in the upper right corner of the sprint card and click Close. The sprint state is changed from Doing to Done.

      If there are unclosed work items in the sprint, a warning dialog box is displayed. You can move these work items to unplanned work items or other sprints, and close these work items (their status changes to Closed).

  • For sprints in the Done state, click in the upper right corner of the sprint card and click Restart. The sprint state is changed from Done to Doing.

You must have permission to set statuses for sprints.

Delete sprint

Click in the upper right corner of the sprint card and click Delete.

  • Deleted sprints cannot be restored.
  • After a sprint is deleted, all work items in the sprint are automatically moved to Unplanned Work Items.

You must have permission to delete sprints.

Plan sprint

You can select unplanned work items or work items under other sprints and drag them to the target sprint (To Do or Doing).

You must have permission to edit sprints.

Check and manage sprint

Click in the upper right corner of a sprint to switch the display mode of sprint work items.
  • Click to switch to the List mode.
  • Click to switch to the Tree mode.
  • Click to switch to the Card mode.
  • Click to switch to the Member mode.

Click on the top to view more details, including work item statistics, burndown charts, and project member data.

Click Create Work Item to create a Story, Task, or Bug.

You can edit the displayed fields on the list page.

All project members can view sprints.

To create a work item in a sprint, you must have permission to create and duplicate work items.

To modify a work item in the sprint list, you must have permission to edit work items.

Edit work item in sprint

For details, see Related Operations, On the Work Item List Page, and On the Work Item Details Page.

You must have the required work item permissions in the project.