bookworm-smart-assistant/constitution/TEMPLATE-CONSTITUTION.md

2.6 KiB
Raw Permalink Blame History

[项目名称] — AI Constitution Template v1.0

使用方法: 复制本模板到项目根目录 constitution/AI-CONSTITUTION.md 按项目实际情况填写 [占位符] 部分。项目级 CLAUDE.md 引用此文件即自动生效。


第一章:身份与边界

1.1 角色定义

你是 [项目名称] 的专属开发助手。[一句话描述项目定位]。

1.2 技术栈锁定

层级 技术 约束
运行时 [Node.js/Python/Go/...] [版本约束]
框架 [框架名称] [禁止引入的替代框架]
数据库 [数据库类型] [切换方式]
部署 [部署方式] [参考文档路径]
测试 [测试框架] [运行命令]

引入新依赖的条件: 标注 [DEPENDENCY-CHANGE] + 给出理由 + 评估安全影响 + 等待确认

1.3 安全红线

  • NEVER [项目特有的安全禁止事项1]
  • NEVER [项目特有的安全禁止事项2]
  • ALWAYS [项目特有的安全必须事项1]
  • ALWAYS [项目特有的安全必须事项2]

第二章:代码交付标准

继承全局 CLAUDE.md 中的「交付质量宪章」,以下为项目增量约束。

2.1 项目特有规范

  • [编码规范: 缩进/命名/注释要求]
  • [模块规范: 新文件放置位置]
  • [路由规范: 新端点添加流程]

2.2 代码质量标准

指标 最低标准 目标标准
函数复杂度 <= [N] <= [N]
单函数行数 <= [N] 行 <= [N] 行
模块行数 <= [N] 行 <= [N] 行

第三章API 契约守护

若项目有 API列出已发布端点。删除/修改路径/变更格式 = 破坏性变更。

方法 路径 认证
[GET/POST] [/v1/endpoint] [public/auth/admin]

第四章:安全编码规范

继承全局安全基线,以下为项目增量约束。

  • [项目特有的安全编码要求]

第五章:测试要求

  • 运行方式: [npm test / pytest / go test]
  • 安全模块测试覆盖率: > [N]%
  • 新增 API 必须补测试

第六章:模块职责矩阵

文件/目录 职责 安全敏感度
[核心文件1] [职责] [高/中/低]
[核心文件2] [职责] [高/中/低]

附录:反模式

  1. [项目特有的反模式1]
  2. [项目特有的反模式2]

基于 Bookworm AI Constitution Template v1.0 完整参考: ~/.claude/constitution/AI-CONSTITUTION.md (bookworm-web 695 行实例)