Updated on 2024-12-04 GMT+08:00

Using a Project Template

In CodeArts, projects are the basis for using services. Operations such as requirement planning, code management, build, and deployment must be performed in CodeArts projects. CodeArts provides multiple preset project templates for different requirement management processes.

Prerequisites

Before creating a CodeArts project, you must have permission to create a project.

If the Create Project button is not displayed on the homepage, you do not have permission to create projects. In this case, contact the administrator to obtain the permission. For details about how to grant the project creator permission to users, see Configuring a CodeArts Project Creator.

Creating a CodeArts Project Using a Project Template

CodeArts provides multiple out-of-the-box project templates, including Scrum, IPD, and Kanban. You can select a project template based on your service scenario.

  1. Click Create Project on the service homepage.
  2. On the Select Template page, select a project template as required. For details about the characteristics and application scenarios of each project template, see Project template features and application scenarios.

    Table 1 Project template features and application scenarios

    Project Template

    Feature

    Application Scenario

    Scrum

    An incremental, iterative software development method. Sprint planning, daily Scrum, sprint review, and sprint retrospectives are key to efficient project management.

    Iterative, incremental software development.

    IPD-System Device

    Software and hardware adaptation involved, fixed product requirements, industry standards available, long development period (6–9 months), high requirements on product quality and stability, many decisions to make, and mainly waterfall development.

    Complex products with embedded software that evolves with hardware. Examples: communications devices, automobiles, home appliances, and consumer electronics.

    IPD-Standalone Software

    Independent software deployment and sales, frequent requirement changes, quick planning, agile development, agile release, and short delivery period (2–3 months or faster).

    IT application and platform software with standardized hardware or independent of dedicated hardware. Examples: ERP software, CRM, databases, and network management software.

  3. Select a project template and click Select. On the Create Project page, set related parameters.

    Table 2 Creating a project

    Parameter

    Description

    Work Item Template

    A work item template contains all configuration items of a Scrum project, except those in Work Item > Statuses and Transitions > Automation > Change Handler. You can select a template as required to quickly reuse the work item configuration data of the project.

    In addition to the default Scrum template of the system, you can customize a work item template. To customize a work item setting template, open a project, go to the Settings > Work Item page, and save the custom template.

    NOTE:

    Work Item Template is available only for Scrum projects.

    Name

    Set this parameter as required.

    The name of projects under the same tenant must be unique.

    Enter only letters, digits, and underscores (_) with a maximum of 128 characters.

    Code

    This parameter is set for third-party services. A project code is set to facilitate service management.

    The value can contain a maximum of 200 characters, including letters, digits, underscores (_), and hyphens (-).

    Associated Enterprise Project (Resource Group)

    You can manage your underlying resources such as VMs, containers, and databases in enterprise projects.

    NOTE:

    Associated Enterprise Project (Resource Group) is available only for Scrum and Kanban projects.

    Description

    Enter a brief description of the project.

    Enter only letters, digits, and underscores (_) with a maximum of 1,024 characters.

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

Related Operations

For a new project, members with the edit permission can choose Settings > General and perform the following operations.

Only Scrum and Kanban projects can be archived.

Table 3 Basic operations on a project

Operation

Procedure

Remarks

Edit basic project information

  1. Choose Basic Information.
  2. Modify the project name, code, description, and enterprise project as required, and click Save.

    The modified information is displayed.

-

Transfer the project creator

  1. Choose Basic Information.
  2. Select the member to transfer the project to from the Creator drop-down list, and click Save.

    The new creator is displayed.

If the project creator is deleted from IAM, the project ownership is automatically transferred to the project manager. If the project creator is also the project manager, the project ownership is transferred to the administrator account.

Archive a project

  1. Choose Basic Information.
  2. Click Archive.

    Then the button changes to Unarchive.

  • Archived projects are read-only to all members. The members cannot add, delete, or modify work items.
  • Archived projects are still counted.

Delete a project

  1. Choose Basic Information.
  2. Click Delete Project. In the displayed dialog box, enter the project name and click Delete.

    The deleted project is no longer displayed on the homepage.

  • Deleting a project will also delete its code repositories, check tasks, build tasks, and test cases.
  • Deleted data cannot be recovered. Exercise caution when performing this operation.

Manage the project service menu

  1. Choose Services.
  2. Select the menus to display.
  3. Refresh the page. The updated menus are displayed in the navigation pane.

-

Manage project members/permissions

  1. Click Permissions.
  2. Refer to Managing CodeArts Project Permissions.

-