docs(repo): add Rust coding standards guidance#1460
Conversation
There was a problem hiding this comment.
Review 总结
变更内容:在 AGENTS.md 中新增「Rust Coding Standards」章节(28 行),并将 CLAUDE.md 简化为 see AGENTS.md(删除 108 行)。目标是让 AGENTS.md 成为唯一权威入口,避免规范来源分散。
内容质量:新增的 Rust 编码规范质量较高,涵盖了 #![no_std] 优先、typed ID/newtype、trait 能力边界、组合优于继承、typed error(thiserror/anyhow 分层)、unsafe 契约、并发原语选择、原子操作发布/观察推理、注释约定等。这些规则与 TGOSKits 的组件/驱动/虚拟化架构高度契合。
CI 状态:head SHA 9bd652b8b0 无 check runs,符合仅文档变更且创建后 91 秒即自合并的情况。文档类 PR 无需本地 fmt/clippy 验证。
重复/重叠分析:未发现与本 PR 意图重叠的 open PR。近期 AGENTS.md/CLAUDE.md 相关提交包括 #1161(review 要求强化)、#1338(issue 解析 skill)、#1180(apps 重组),均不冲突。
咨询性建议(非阻塞)
CLAUDE.md 技术参考内容未迁移
CLAUDE.md 原有 108 行中包含以下仅存在于该文件的技术参考信息,现已删除但未迁移至 AGENTS.md:
- Repository Overview:ArceOS / StarryOS / Axvisor 三系统关系及依赖流
- Build System & Common Commands:
cargo xtask arceos qemu、cargo xtask starry rootfs、cargo xtask axvisor qemu等具体命令 - Cargo Aliases:
cargo arceos、cargo starry等快捷方式 - Toolchain:
nightly-2026-04-27、四个*-unknown-nonetarget、容器镜像 - Code Style:
rustfmt.toml配置项 - Architecture:Components 列表、Drivers 四层模型(Driver Core / Capability Boundary / OS Glue / Runtime)、rdif/rdrive 框架、Platform 板级 crate
- CI Pipeline:fmt / clippy / sync-lint / std tests / QEMU tests / board tests 详情
README.md 覆盖了部分仓库结构和快速体验,但上述具体构建命令、工具链版本、CI 管线和架构细节对 AI agent 工作流仍有参考价值。建议后续补充到 AGENTS.md 或新建专门的参考附录。
结论:PR 已合并,编码规范新增内容质量良好,无阻塞问题。技术参考内容迁移可作为后续改进。
Powered by mimo-v2.5-pro
背景
当前仓库的根级协作规范里缺少面向 Rust/TGOSKits 的统一编码规范,而
CLAUDE.md又保留了一份和AGENTS.md部分重叠的说明,后续维护容易出现规范来源分散和内容漂移。变更
AGENTS.md中新增Rust Coding Standards章节,将《代码整洁之道》中可迁移的命名、函数职责、对象拆分、组合、错误处理、注释、并发和重构原则,改写成适合 Rust、no_std、内核/驱动/虚拟化场景的规范。anyhow做顶层报告,ArceOS/kernel 集成边界再转换到AxError/AxResult。CLAUDE.md简化为see AGENTS.md,让AGENTS.md成为唯一权威入口。方案逻辑
AGENTS.md,避免多个入口长期重复维护。unsafe契约和并发约束上。Other Requirements,新增章节只补编码设计准则,不重复已有流程规则。验证
git diff --checkgit diff --check HEAD~1..HEAD本次仅修改文档,未运行
cargo fmt或 clippy。