Skip to content

编码规范库 (Rules) ​

所有编码规范、代码检查清单、质量标准都在此统一管理。

目录结构 ​

common/ - 通用规范 ​

  • coding-style.md - 代码风格规范
  • security.md - 安全规范
  • performance.md - 性能规范
  • testing.md - 测试规范
  • documentation.md - 文档规范

frontend/ - 前端特有规范 ​

  • vue-component.md - Vue 组件规范
  • typescript.md - TypeScript 规范
  • styling.md - 样式规范
  • state-management.md - 状态管理规范
  • api-integration.md - API 集成规范
  • routing.md - 路由规范

h5-pipeline/ - H5 项目特有规范 ​

  • contract-layer.md - 协议层规范
  • business-layer.md - 业务层规范
  • ui-layer.md - UI 层规范

使用方式 ​

这些规范被以下系统使用:

  1. Check Agent - 遵守这些规范进行代码检查
  2. Critic Agent - 分析哪些规范最常被违反
  3. Refiner Agent - 根据违反情况优化规范内容

规范迁移来源 ​

  • common/ - 来自 .claude/rules/common/ 中的通用规范
  • frontend/ - 来自 .claude/rules/frontend/ 中的规范
  • h5-pipeline/ - 来自 .claude/rules/h5-pipeline/ 中的规范

贡献指南 ​

当发现新的编码模式或规范需要更新时:

  1. 编辑相应的 .md 文件
  2. 提交代码并记录在会话日志中
  3. Refiner Agent 会在周期性分析中更新这些规范