完整的代码规范和模板系统，用于提升 AI 辅助开发的代码质量和一致性、遵循云与AI卓越架构、遵循最佳实践和开发范式。
qoder-rules/
├── core/ # 核心规范（必需）
│ ├── requirements-spec.md # 开发需求规范（13条规则）
│ ├── requirements-spec.zh-CN.md
│ ├── workflow-spec.md # 工作流规范（12条规则）
│ ├── workflow-spec.zh-CN.md
│ ├── naming-conventions.md # 命名约定（12条约定）
│ ├── naming-conventions.zh-CN.md
│ ├── spec-index.md # 中心索引和配置
│ └── spec-index.zh-CN.md
│
├── quality/ # 质量保证规范（推荐）
│ ├── testing-spec.zh-CN.md # 测试规范（12条规则）
│ ├── security-spec.zh-CN.md # 安全规范（12条规则）
│ └── error-handling-spec.zh-CN.md # 错误处理规范（12条规则）
│
├── architecture/ # 架构设计规范（可选）
│ ├── alibaba-cloud-ai-spec.zh-CN.md # 阿里云AI架构规范（12条规则）
│ └── api-design-spec.zh-CN.md # API 设计规范
│
├── process/ # 流程规范
│ └── git-workflow-spec.zh-CN.md # Git 工作流规范
│
├── operations/ # 运维规范
│ └── deployment-spec.zh-CN.md # 部署规范
│
├── tools/ # 规范验证工具
│ ├── spec-lint.py # 规范检查工具
│ └── spec-report.js # 合规报告生成器
│
└── README.md # 本文件
# 克隆整个仓库
git clone https://github.com/your-repo/qoder-rules.git
cd qoder-rules将规范文件复制到项目的 .qoder/rules 目录：
# 复制核心规范
mkdir -p .qoder/rules
cp core/*.md .qoder/rules/
cp quality/*.md .qoder/rules/
cp architecture/*.md .qoder/rules/在 Qoder IDE 或其他 AI 辅助开发工具中：
@core/requirements-spec.zh-CN.md
@quality/testing-spec.zh-CN.md
@architecture/alibaba-cloud-ai-spec.zh-CN.md
请生成一个用户登录功能，严格遵循这些规范。
13 条关键规则，确保代码完整性、可运行性和质量：
- ✅ RULE 1 - 生成完整可运行代码（无 TODO、无占位符）
- ✅ RULE 2 - 复用现有代码和 API
- ✅ RULE 3 - 最小化新增依赖
- ✅ RULE 6 - 验证所有 API 是否存在（关键）
- ✅ RULE 10 - 确保代码成功编译（关键）
- ✅ RULE 13 - 只使用真实存在的库（关键）
12 条测试标准，确保代码质量：
- 测试完整性 - 新功能必须包含测试
- 覆盖率目标 - Web 70%+, CLI 80%+, Library 85%+
- 测试分层 - 单元测试 70%, 集成 20%, E2E 10%
- Mock 规范 - 外部依赖必须 Mock
12 条安全标准，防护常见漏洞：
- 输入验证与清理 - 防止注入攻击
- 认证与授权 - 强认证细粒度授权
- 敏感数据保护 - 加密存储和传输
- OWASP Top 10 防护
12 条错误处理标准：
- 错误分类 - 业务/系统/第三方错误
- 自定义错误类 - 领域特定错误
- 用户友好提示 - 清晰可操作消息
- 全局错误处理器 - 统一错误中间件
# 推荐启用的规范
core/requirements-spec.txt [启用 RULE 1,2,3,5,6,7,10,11,12,13]
core/workflow-spec.txt [启用 RULE 1,2,6,9,10,12]
core/naming-conventions.txt [启用 CONVENTION 1-6,9]
quality/testing-spec.txt [启用 RULE 1-9, 目标覆盖率 70%]
quality/security-spec.txt [启用 RULE 1-11]
quality/error-handling-spec.txt [启用 RULE 1-11]# 推荐启用的规范
core/requirements-spec.txt [启用 RULE 1,2,3,5,6,7,10,12,13]
quality/testing-spec.txt [启用 RULE 1-9, 目标覆盖率 80%]
quality/security-spec.txt [启用 RULE 1,3,4,6,8,11]
quality/error-handling-spec.txt [启用 RULE 1-7,10,11]# 推荐启用的规范
core/requirements-spec.txt [启用 RULE 1,2,3,6,7,10,12,13]
quality/testing-spec.txt [启用 RULE 1-10, 目标覆盖率 85%]
quality/error-handling-spec.txt [启用 RULE 1,2,5,6,10,12]# 检查当前目录
python tools/spec-lint.py
# 指定目录
python tools/spec-lint.py --target-dir ./src --spec-dir ./core
# 输出示例:
# 🔍 检查目录: ./src
# 发现 3 个问题:
# ❌ 错误: 1
# ⚠️ 警告: 2# 生成报告
node tools/spec-report.js
# 保存为 JSON
node tools/spec-report.js --output compliance-report.json
# 输出示例:
# 📋 规范遵守情况报告
# 总体合规率: 85%
# 已启用规则: 34/40规范文件支持 trigger: manual frontmatter，可直接在 .qoder/rules 目录中使用：
---
trigger: manual
---在对话中使用 @ 符号引用规范文件。
推荐安装的扩展：
- ESLint - 代码检查
- Prettier - 代码格式化
- EditorConfig - 编辑器配置
- GitHub Copilot - AI代码助手
- Cursor
- Continue
- Codeium
所有支持文件引用的 AI 编辑器都可以使用这些规范。
@core/requirements-spec.zh-CN.md
@quality/security-spec.zh-CN.md
@quality/error-handling-spec.zh-CN.md
生成一个登录页面，包含：
1. 邮箱和密码输入
2. 表单验证
3. 错误处理
4. 安全的密码处理
@architecture/alibaba-cloud-ai-spec.zh-CN.md
@core/requirements-spec.zh-CN.md
参考MBTI项目的实现，使用通义千问构建一个智能问答系统。
要求：
- 使用规则3（大模型调用）
- 实施规则9（成本优化）
- 遵循规则7（监控日志）
@quality/testing-spec.zh-CN.md
@core/naming-conventions.zh-CN.md
为 UserService 类生成单元测试，确保：
- 覆盖率 > 85%
- 包含边界条件测试
- 使用 Mock 隔离外部依赖
在 .git/hooks/pre-commit 中添加：
#!/bin/bash
# 提交前检查规范
python tools/spec-lint.py
if [ $? -ne 0 ]; then
echo "规范检查失败，请修复后再提交"
exit 1
fi在 GitHub Actions / GitLab CI 中添加：
# .github/workflows/spec-check.yml
name: Spec Compliance Check
on: [push, pull_request]
jobs:
spec-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Run spec lint
run: python tools/spec-lint.py
- name: Generate compliance report
run: node tools/spec-report.js --output report.json
- name: Upload report
uses: actions/upload-artifact@v3
with:
name: compliance-report
path: report.json- ✅ 规则3: 大模型调用与管理（通义千问）
- ✅ 规则7: 监控与可观测性（日志记录）
- ✅ 规则8: 数据安全与合规（数据脱敏）
- ✅ 规则9: 成本优化（缓存机制）
| 规范文件 | 规则数 | 关键规则 | 适用项目 |
|---|---|---|---|
| requirements-spec | 13 | 4 | All |
| workflow-spec | 12 | 6 | All |
| naming-conventions | 12 | 5 | All |
| testing-spec | 12 | 9 | All |
| security-spec | 12 | 11 | Web, API |
| error-handling-spec | 12 | 11 | All |
| alibaba-cloud-ai-spec | 12 | 10 | AI Applications |
| git-workflow-spec | 10 | 8 | All |
| deployment-spec | 10 | 8 | Production |
| api-design-spec | 10 | 7 | API Projects |
总计: 100+ 条规则，覆盖代码质量、安全、测试、工作流、AI架构等各个方面。
所有规范文件包含 frontmatter 元数据，可直接作为 Qoder IDE 的 Rules 使用：
---
trigger: manual
---提供完整的阿里云 AI 应用架构最佳实践：
- 通义千问集成
- DashVector 向量检索
- PAI 模型部署
- SLS 日志监控
- 成本优化策略
核心规范提供中英文版本，方便不同团队使用。
欢迎提交 Issue 和 Pull Request 改进规范！
MIT License
最后更新: 2025-11-10
版本: v1.0.0