AGENTS.md 967 Bytes

仓库协作规则

文档规则

  • 本仓库中的需求文档、设计文档、计划文档、进度文档、说明文档统一使用中文编写。
  • 遇到路径、命令、库名、API 名称、类型名等技术标识时,可保留原文,不强制翻译。
  • 新增文档时,标题、章节说明、结论、风险、验收标准等面向人的内容必须使用中文。

代码注释规则

  • 页面主要逻辑上的注释统一使用中文。
  • 组件页面中与业务流程、交互状态、核心分支、数据转换相关的关键注释必须使用中文。
  • 注释应简洁明确,优先解释“为什么这样做”或“这一段主要负责什么”,避免无意义的逐行翻译式注释。

执行要求

  • 修改已有文档时,优先检查是否存在英文标题或英文说明,若有则同步转成中文。
  • 新增页面或重构页面逻辑时,需要检查主要逻辑处是否补充了必要的中文注释。