Skip to content

Commit 4253888

Browse files
committed
docs: 更新AGENTS.md文档规范与注释要求
- 明确任务完成后的质量检查步骤 - 新增代码注释规范要求:公共接口需标注核心功能、参数和返回值,非直观逻辑需说明设计意图 - 统一OpenSpec文档语言规范:结构关键词保持英文,其余叙述使用简体中文 - 明确skill创建时的语言使用规则
1 parent 69bcae0 commit 4253888

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
每个任务完成时,执行根目录pnpm qa修复出现的问题
1+
- 每个任务完成时,执行根目录pnpm qa修复出现的问题
2+
- 你必须为所有输出的代码补充清晰规范的注释。公共接口标注核心功能、入参、返回值,非直观逻辑补充设计意图,- 不重复代码本身的语义。
3+
- 创建skill时使用中文,除了术语等
24

35
当创建或更新 `openspec/changes/**``openspec/specs/**` 下的 OpenSpec 工件(`proposal.md``design.md``tasks.md``specs/**/*.md``validation.md`)时:
46

57
1) OpenSpec 模板中的 Markdown 标题与小节名保持英文原文,不做翻译(如 `Why``What Changes``Context``Goals / Non-Goals``Decisions``Risks / Trade-offs``Migration Plan``Open Questions``Impact``Capabilities``New Capabilities``Modified Capabilities`)。
68
2) OpenSpec 结构关键词与固定术语保持原样(`ADDED Requirements``MODIFIED Requirements``REMOVED Requirements``RENAMED Requirements``Requirement``Scenario``WHEN``THEN``BREAKING`)。
79
3) 除上述标题、关键词与固定术语外,其余叙述必须使用简体中文。
810
4) 代码、命令、路径、参数名保持原样。
9-
10-
11-
创建skill时使用中文,除了术语等

0 commit comments

Comments
 (0)