Using a Sample Project

Updated on 2025-01-17 GMT+08:00

View PDF

Sample projects use default templates that include work items and processes preset in CodeArts Req. After you select a sample project, the corresponding sample template project is automatically generated for your reference. The work items and code preset in the sample project can be directly used.

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 Sample Project

Click Create Project on the service homepage.

On the Select Template page, select a sample project to create a project. Table 1 lists the supported sample projects.

**Table 1** Sample projects
Project Type	Project Name	Application Scenario
Scrum	DevOps Full-Process	Agile development and DevOps continuous delivery through an automated E2E process. The templates have preset mind maps and instantiated Scrum work items (promotion, member, and order management), code repositories, code check tasks, build tasks, and pipeline tasks.
Scrum	One-Stop HarmonyOS Application Development	The sample project provides a one-stop distributed application development platform for all scenarios. It supports distributed multi-device development, debugging, and simulation, providing all-round quality and security assurance.
IPD	IPD-System Device	Complex products with embedded software that evolves with hardware. Examples: communications devices, automobiles, home appliances, and consumer electronics.
	IPD-Standalone Software	IT application and platform software with standardized hardware or independent of dedicated hardware. Examples: ERP software, CRM, databases, and network management software.
	IPD-Self-Operated Software/Cloud Service	Cloud service development, microservice architecture, and self-operated software scenarios, such as public cloud and Internet application software.

Select a sample project. On the Create Project page, set related parameters.

**Table 2** Creating a project
Parameter	Description
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 (-).
Description	Enter a brief description of the project. Enter only letters, digits, and underscores (_) with a maximum of 1,024 characters.

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.

**Table 3** Basic operations on a project
Operation	Procedure	Remarks
Edit basic project information	Choose Basic Information. Modify the project name, code, description, and enterprise project as required, and click Save. The modified information is displayed.	-
Transfer the project creator	Choose Basic Information. 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	Choose Basic Information. 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. Only Scrum projects can be archived.
Delete a project	Choose Basic Information. 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	Choose Services. Select the menus to display. Refresh the page. The updated menus are displayed in the navigation pane.	-
Manage project members/permissions	Click Permissions. Refer to "Managing CodeArts Project Permissions".	-