Skip to content

docs(repo): add Rust coding standards guidance#1460

Merged
ZR233 merged 1 commit into
rcore-os:devfrom
ZR233:codex/agents-rust-coding-standards
Jul 1, 2026
Merged

docs(repo): add Rust coding standards guidance#1460
ZR233 merged 1 commit into
rcore-os:devfrom
ZR233:codex/agents-rust-coding-standards

Conversation

@ZR233

@ZR233 ZR233 commented Jul 1, 2026

Copy link
Copy Markdown
Member

背景

当前仓库的根级协作规范里缺少面向 Rust/TGOSKits 的统一编码规范,而 CLAUDE.md 又保留了一份和 AGENTS.md 部分重叠的说明,后续维护容易出现规范来源分散和内容漂移。

变更

  • AGENTS.md 中新增 Rust Coding Standards 章节,将《代码整洁之道》中可迁移的命名、函数职责、对象拆分、组合、错误处理、注释、并发和重构原则,改写成适合 Rust、no_std、内核/驱动/虚拟化场景的规范。
  • 明确用 Rust 的 trait 能力边界、newtype/typed ID、组合和 adapter 分层替代 Java 式继承层次设计。
  • 补充错误处理约定:library/domain crate 暴露 typed error,host-side bin/tool crate 使用 anyhow 做顶层报告,ArceOS/kernel 集成边界再转换到 AxError/AxResult
  • CLAUDE.md 简化为 see AGENTS.md,让 AGENTS.md 成为唯一权威入口。

方案逻辑

  • 编码规范集中在 AGENTS.md,避免多个入口长期重复维护。
  • 新增规则保留 Clean Code 的核心思想,但落到 Rust 的所有权、模块边界、trait 能力、组合、typed error、unsafe 契约和并发约束上。
  • 现有构建、clippy、PR 和 CI 要求保留在 Other Requirements,新增章节只补编码设计准则,不重复已有流程规则。

验证

  • git diff --check
  • git diff --check HEAD~1..HEAD

本次仅修改文档,未运行 cargo fmt 或 clippy。

@ZR233
ZR233 marked this pull request as ready for review July 1, 2026 02:17
@ZR233
ZR233 merged commit 9847d3c into rcore-os:dev Jul 1, 2026
@ZR233
ZR233 deleted the codex/agents-rust-coding-standards branch July 1, 2026 02:18

@mai-team-app mai-team-app Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Commandscargo xtask arceos qemucargo xtask starry rootfscargo xtask axvisor qemu 等具体命令
  • Cargo Aliasescargo arceoscargo starry 等快捷方式
  • Toolchainnightly-2026-04-27、四个 *-unknown-none target、容器镜像
  • Code Stylerustfmt.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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant