Help Center/ CodeArts Agent/ Best Practices/ Code Check and Intelligent Defect Fixing Using CodeArts Check MCP/ Creating a CodeArts Project and Configuring Code Check Rules
Updated on 2026-08-04 GMT+08:00
View PDF
Share

Creating a CodeArts Project and Configuring Code Check Rules

Creating a Project and a Code Repository

  1. Log in to CodeArts console using an account with the project creation permission and select AP-Singapore.
  2. Click Go to Workspace in the upper right corner to go to the CodeArts project homepage.
  3. Click Create > Create Project.
  4. On the CodeArts homepage, find the Scrum template and click Select.
  5. Enter a project name (for example, req-demo), and click OK. Keep the name under 128 characters.

    The project is created, and the Work Items page of CodeArts Req is displayed. By default, the project creator is the project manager.

  6. In the navigation pane on the left, choose Code > Repo as the project manager to access CodeArts Repo.
  7. Click Create Repository.
  8. Select Template and click Next.
  9. Select the Java Web Demo template and click Next.
  10. Enter a repository name (for example, repo-demo). Start the name with a letter, digit, or underscore (_), and use letters, digits, hyphens (-), underscores (_), and periods (.). Do not end the name with .git, .atom, or a period.
  11. Choose Public > For project members under Visibility, and click OK.

    The repository is created, and its Code page is displayed.

  12. Choose Code > Branches and click Create Branch. In the displayed dialog box, set the following parameters and click OK.

    A message is displayed, indicating that the operation is successful. The Files page is automatically displayed, showing the develop-dev branch.
    Table 1 Setting parameters for creating a branch

    Parameter

    Example Value

    Description

    Based On

    master

    Select an existing branch.

    Branch Name

    develop-dev

    Name of the branch you are creating. The name cannot exceed 200 bytes.

    • Do not start with a hyphen (-), period (.), refs/heads/, or refs/remotes/.
    • Do not use spaces or special characters such as open square brackets ([), backslashes (\), less-than signs (<), tildes (~), carets (^), question marks (?), asterisks (*), exclamation marks (!), single quotation marks ('), double quotation marks ("), and vertical bars (|).
    • Do not end with a period (.), slash (/), or .lock.

    CodeArts Req Work Items to Associate

    /

    Associate an existing work item with the branch.

    By default, no Req work item is associated.

  13. Click Settings on the top navigation bar, choose Security Management > Permissions in the left navigation pane, and enable Use Project Permissions to inherit project-level permissions.

Configuring Code Check Rules

  1. Log in to CodeArts console as a project manager, and select AP-Singapore.
  2. Click Go to Workspace in the upper right corner to go to the CodeArts project homepage.
  3. Click the req-demo card to go to the homepage of the project.
  4. In the navigation pane, choose Code > Check to go to the CodeArts Check homepage.
  5. On the Tasks tab, click in the row where repo-demo-check is located, and click Settings to go to the Basic Info page of repo-demo-check.
  6. On the Basic Info page, set Default Branch to develop-dev and click Save.
  7. On the Check Scope page, set Version Check to Last Commit and click Save.
  8. On the Integration Service page, select Triggered upon code commit and click Save.
Parent Topic: Code Check and Intelligent Defect Fixing Using CodeArts Check MCP