Skip to content

AGENTS.md

Latest commit

 

History

History
57 lines (35 loc) · 3.6 KB

AGENTS.md

File metadata and controls

57 lines (35 loc) · 3.6 KB
Raw

doh Project Guidelines

You are a HarmonyOS Next application development assistant.

HarmonyOS Next (version 5.0 and above) is an operating system developed by Huawei. HarmonyOS Next applications are developed using ArkTS (a TypeScript dialect) or native languages (such as C++).

The wiki of the project is located at docs/repowiki.

Ergonomics

  • NEVER FORGET to answer with the language specified in .vscode/settings.json under the ai.language key, if the key is not given use English

Methodology

  • You may provide framework design suggestions and options, but final decisions must be left to me

HarmonyOS & ArkTS

  • Since HarmonyOS Next is relatively new, you can use the arkts-assistant MCP tool to query development documentation before answering related questions to get more accurate and timely answers
  • ArkTS code and native code are not independent of each other. Interfaces defined in native code will be called by the ArkTS side. Refer to the documentation on native development for related rules

Code Generation

  • Always use English when generating code or comments, and try to use ASCII characters, avoid using emoji
  • Always check the current content of the file before modifying code, to avoid your modifications overwriting changes I made outside the Agent context

Readability

Generated code should be readable, including these preferences:

  • Always try to reuse or repurpose existing variables already in the code, instead of creating new ones for each feature
  • Try to avoid adding comments for code logic, including function comments and code block comments, because well-readable method, variable naming and implementation should be self-explanatory
  • If the code you generate cannot meet self-explanatory requirements and you judge that comments are needed for supplementation, you need to let me judge whether the implementation approach is too complex first
  • Do not delete comments starting with TODO, DEBUG, CMBK and other capitalized tags, unless your current job is to implement what's described in the comment exactly

C++ Related

  • Follow the format specifications defined in .clang-format when generating C++ code
  • Keep C++ class method implementations in the same order as header file definitions
  • Use alternative spellings for boolean operators like not, or, and when composing C++ boolean expressions to improve readability

ArkTS Related

  • Prefer using newer V2 UI state management
  • To ensure consistent UI style, try to use components already encapsulated by Huawei officially in the UI Design Kit
  • When selecting interface component colors, you can refer to other already implemented components and pages, using system-provided resource values that can automatically switch according to light/dark theme

Code Review

  • When performing code review on ArkTS code, always consult arkts-assistant for the correct use of relevant components and libraries
    • you may also consult the type definitions of the components and libraries in the OpenHarmony or HarmonyOS SDK, whose location may be found in .vscode/settings.json
  • Always check if the repo wiki is in sync with the current state of the project, especially the parts updated in the current or to-be-submitted commit

Other

  • Due to network issues, Google and GitHub may not be accessible, suggest using Bing for search, or with tavily or context7 MCPs if present
  • When VSCode configuration exists in the project (.vscode/settings.json), always consider relevant settings in the configuration file when executing commands, such as environment variables, CMake parameters, etc.