Skip to content

AI 协作规范

本文档与 CLAUDE.md 互为补充,规范 AI Agent 的行为准则。

适用于 Claude Code、Cursor、Copilot 等 AI 工具。

1. 需求与任务管理

  • 需求确认后,AI 辅助拆解为可执行任务,输出任务列表并关联对应文档
  • 每个任务完成时,AI 需同步更新关联文档和任务状态
  • 禁止 AI 在需求未确认前直接开始编码

2. 代码审查(CR)规范

  • 每次 CR 生成结构化报告,包含:审查范围、关键发现、修复建议
  • 严重问题(安全、性能、逻辑错误)必须人工复核后方可合并
  • 评级标准:A(优秀)/ B(良好)/ C(需修复)/ D(拒绝)

3. 提交规范

  • Commit message 使用 Conventional Commits 格式
  • type 使用英文,描述使用中文(如 feat: 添加用户登录
  • 禁止无意义提交(如 fix: 111update

4. AI 安全边界

  • 禁止 AI 处理或生成密钥、Token、密码等敏感信息
  • 禁止 AI 直接执行生产环境操作(部署、数据库变更、数据删除)
  • 禁止 AI 执行破坏性命令(rm -rfDROP TABLEgit reset --hard
  • AI 发现硬编码敏感信息或安全漏洞时主动告警

5. AI 编码规范

  • 圈复杂度不超过 10,超过必须拆分
  • 只写 WHY 注释,不写 WHAT 注释
  • 引入新 API / 库前确认其真实存在
  • 禁止生成 mock 数据作为生产代码
  • 代码必须通过项目已有 lint 规则

6. AI Memory 管理

  • 使用 .claude/memory/ 或等效机制记录跨会话上下文
  • 会话结束时总结本次变更要点和待办事项
  • 多会话交接时优先读取 Memory 和 AGENTS.md

7. 工具使用限制

  • 写操作(文件删除、git push、npm publish)前需用户确认
  • AI 可自主执行:文件读取、代码分析、lint 检查、本地测试
  • 使用外部 API 时说明调用目的和预期副作用

基于 MIT 协议开源