chore: update existing rule docs with AI output schema

This commit is contained in:
qg
2026-03-30 11:19:22 +08:00
parent 03a5087260
commit 4ddae35ffb
19 changed files with 103 additions and 26 deletions

19
append_rules.py Normal file
View File

@@ -0,0 +1,19 @@
import os
appends = {
"02 - Design Standard/2.1 系统架构设计原则.md": "\n\n## 🤖 [附加] AI 助手执行协议 (AI Output Schema)\n\n**绝对红线**:默认采用模块化单体架构,除非明确要求否则禁止过度微服务拆分;强制遵循下层不可反向依赖上层的单向依赖流。\n",
"02 - Design Standard/2.2 API 接口设计规范.md": "\n\n## 🤖 [附加] AI 助手执行协议 (AI Output Schema)\n\n**绝对红线**:接口文档必须输出为 OpenAPI 3.0 YAML 格式;所有 HTTP 接口的响应体必须强制包裹在统一的 `{code, msg, data}` JSON 结构中。\n",
"02 - Design Standard/2.3 数据库与存储设计规范.md": "\n\n## 🤖 [附加] AI 助手执行协议 (AI Output Schema)\n\n**绝对红线**强制输出两部分内容1. Mermaid 格式的 ER 图2. 包含 [表名、字段名、类型、是否为空、默认值、索引说明] 的标准 Markdown 表格。\n",
"03 - Coding & Frameworks/01 - Language Coding Specification/Python 编码与开发规范.md": "\n\n## 🤖 [附加] AI 助手执行协议 (AI Output Schema)\n\n**绝对红线**:生成的 Python 代码必须 100% 包含 Type Hints类型注解禁止输出废话解析直接输出带规范中文注释的可用代码块。\n",
"03 - Coding & Frameworks/02 - Framework Development Specification/Django_DRF开发规范.md": "\n\n## 🤖 [附加] AI 助手执行协议 (AI Output Schema)\n\n**绝对红线**:严格执行 Fat Service 模式。models.py 仅定义数据services.py 处理所有核心业务逻辑views.py 仅负责路由接客,绝对禁止在 View 中写复杂业务查询。\n",
"04 - Quality & Review/4.1 自动化测试规范.md": "\n\n## 🤖 [附加] AI 助手执行协议 (AI Output Schema)\n\n**绝对红线**:强制使用 pytest 框架;测试用例内部必须使用注释显式划分为 `# Arrange`, `# Act`, `# Assert` 三个标准区块。\n",
"04 - Quality & Review/4.2 代码审查规范.md": "\n\n## 🤖 [附加] AI 助手执行协议 (AI Output Schema)\n\n**绝对红线**:提供安全漏洞与架构越权的排查 Checklist。规定 AI 必须逐项回复检查结果True/False一旦发现违规必须输出重构后的安全代码。\n",
"04 - Quality & Review/4.3 安全编码规范.md": "\n\n## 🤖 [附加] AI 助手执行协议 (AI Output Schema)\n\n**绝对红线**:提供安全漏洞与架构越权的排查 Checklist。规定 AI 必须逐项回复检查结果True/False一旦发现违规必须输出重构后的安全代码。\n",
"05 - Collaboration & Delivery/5.2 CI_CD 与环境部署规范.md": "\n\n## 🤖 [附加] AI 助手执行协议 (AI Output Schema)\n\n**绝对红线**:生成的 Dockerfile 必须采用多阶段构建 (Multi-stage Build) 并锁定基础镜像版本;必须配套输出标准的 `.env.example` 环境变量清单。\n",
}
for path, content in appends.items():
with open(path, "a", encoding="utf-8") as f:
f.write(content)
print("Appended rules successfully.")