feat(docs): Add AGENTS.md for project guidelines and development instructions#37
feat(docs): Add AGENTS.md for project guidelines and development instructions#37
Conversation
走访总览本PR添加了项目指导文档AGENTS.md,包含目录组织结构、构建与测试命令、代码风格规则、lint工作流程以及提交流程规范。同时更新了CLAUDE.md文件以引用新增文档。 变更内容
代码审查工作量估计🎯 1 (Trivial) | ⏱️ ~3 分钟 兔兔之诗
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip CodeRabbit can use Clang for C/C++ static analysis and code quality checks.Clang provides comprehensive static analysis for C and C++ code, including syntax checking, type checking, and various warning diagnostics. |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
CLAUDE.md (1)
1-1: 建议改为明确的 Markdown 链接。当前是裸文件名,建议改为可点击链接并补一句用途说明,减少读者歧义(例如“详细规范见 AGENTS.md”)。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CLAUDE.md` at line 1, 在 CLAUDE.md 中把裸文件名 "AGENTS.md" 替换为明确的 Markdown 链接并补充用途说明:查找文本 AGENTS.md(在 CLAUDE.md 中出现的位置,例如链接列表或参考处),将其改为可点击的 Markdown 链接形式并在同一段或下一句添加一句短说明(例如“详细规范见 AGENTS.md,用于说明 Agent 行为与接口规范”),以减少歧义并让读者知道该文件的用途。AGENTS.md (1)
42-42: 请澄清“严禁执行 git add”的适用范围。这句放在“提交指南”里容易被理解为对所有贡献者生效,建议明确为“仅针对自动化 Agent 的评审流程约束”,避免与常规开发提交流程产生歧义。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` at line 42, Update the ambiguous guideline sentence "Git unstaged changes 是必要的 code review 渠道。Agent 严禁执行 git add。" in AGENTS.md to explicitly scope the prohibition to automation agents only—e.g., change to wording like "仅针对自动化 Agent(自动运行的脚本或机器人)的评审流程约束:严禁执行 git add。"—so contributors understand normal human workflows are unaffected; locate and replace the exact sentence in AGENTS.md and ensure surrounding "提交指南" text references "自动化 Agent" rather than all contributors.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@AGENTS.md`:
- Line 42: Update the ambiguous guideline sentence "Git unstaged changes 是必要的
code review 渠道。Agent 严禁执行 git add。" in AGENTS.md to explicitly scope the
prohibition to automation agents only—e.g., change to wording like "仅针对自动化
Agent(自动运行的脚本或机器人)的评审流程约束:严禁执行 git add。"—so contributors understand normal human
workflows are unaffected; locate and replace the exact sentence in AGENTS.md and
ensure surrounding "提交指南" text references "自动化 Agent" rather than all
contributors.
In `@CLAUDE.md`:
- Line 1: 在 CLAUDE.md 中把裸文件名 "AGENTS.md" 替换为明确的 Markdown 链接并补充用途说明:查找文本
AGENTS.md(在 CLAUDE.md 中出现的位置,例如链接列表或参考处),将其改为可点击的 Markdown
链接形式并在同一段或下一句添加一句短说明(例如“详细规范见 AGENTS.md,用于说明 Agent 行为与接口规范”),以减少歧义并让读者知道该文件的用途。
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ae0c21da-2903-42cb-a403-57e02b7e205b
📒 Files selected for processing (2)
AGENTS.mdCLAUDE.md
概述
新增仓库指南文档
AGENTS.md,为开发者提供项目组织、构建流程、代码风格和提交规范的详细说明。核心变更
新增文件:
AGENTS.md项目结构
core/(共享协议和工具)、host/(桌面SDK)、firmware/rmcs_board/(HPM板卡固件)、firmware/c_board/(STM32固件)等模块的职责bsp/为第三方子模块依赖,.scripts/包含 CI 对齐的工具脚本开发命令
clang-format-check --fix、clang-tidy-check)代码规范
质量与提交规范
!标记、冒号后首字母大写新增/修改文件
AGENTS.md(+46 行)CLAUDE.md更新(+1 行,添加了对 AGENTS.md 的记录)代码审查难度
低(纯文档新增)