Skip to content

docs: 添加 AGENTS 指南#95

Draft
MRNIU wants to merge 1 commit intodrivercraft:mainfrom
MRNIU:feature/add-agent-guidance
Draft

docs: 添加 AGENTS 指南#95
MRNIU wants to merge 1 commit intodrivercraft:mainfrom
MRNIU:feature/add-agent-guidance

Conversation

@MRNIU
Copy link
Copy Markdown

@MRNIU MRNIU commented May 6, 2026

摘要

  • 新增仓库根目录 AGENTS.md,记录 AI 辅助改动时需要遵循的项目边界。
  • 为各 workspace crate 和 ostool-server/webui 增加局部 AGENTS.md
  • 指南聚焦仓库已有事实:CI 证据、package 边界、生成产物、硬件敏感路径和验证入口。

社区问题

这个 PR 提议通过 AGENTS.md 记录 AI 辅助开发时的协作约定。社区是否接受这种 AI 驱动的开发模式,以及把相关约定放在 AGENTS.md 中?

如果社区更倾向于其他位置、措辞、语言或范围,这个 draft PR 先作为讨论入口;确认方向后再标记为 ready。

Review 说明

  • 文档主体使用中文,以匹配当前默认根 README。
  • 指南避免引入仓库未声明的额外环境假设,例如 Docker-first 或本地安装工具链之类的规则。
  • ostool-server 指南明确说明 cargo test -p ostool-server 可能会通过 build.rs 调用 pnpm;工具不可用时应说明跳过,而不是改变工具来源或提交生成产物来掩盖差异。
  • 分支名使用 README 贡献指南中的 feature/... 风格。
  • 当前分支相对上游只有一个提交,提交信息为中文。

验证

  • 未运行 Cargo/pnpm 测试:本 PR 只新增文档文件。

为仓库和各 workspace 成员补充 AGENTS.md,明确 AI 辅助改动时应遵循的项目边界。

- 根目录记录项目结构、依赖与工具、提交、验证和文档约定。

- 子项目记录各 crate 与 web UI 的局部规则和验证入口。

- 避免引入仓库未声明的环境假设,缺少工具时要求如实说明。
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