Skip to content

Commit 2ca8001

Browse files
authored
feat(rules): optimize CloudBase AI development guidelines 📋 (#121)
- Improve rule enforcement mechanism to ensure AI follows scenario-specific guidelines - Optimize title from 'forced rules index' to friendly 'development guidelines' - Strengthen scenario identification workflow (Web/MiniProgram/Database/UI) - Add clear rule file mapping table for different project types - Restore version detection with simplified implementation - Add development quality checklist to prevent common mistakes - Update wording from mandatory terms to professional suggestions - Ensure all AI IDEs use consistent configuration via hardlinks
1 parent 1533041 commit 2ca8001

14 files changed

Lines changed: 1344 additions & 1512 deletions

File tree

config/.augment-guidelines

Lines changed: 96 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,49 @@
11

22
---
33
cloudbaseAIVersion:1.8.28
4-
description: CloudBase AI 开发规则索引 - 防止不同开发场景的规则互相干扰
4+
description: CloudBase AI 开发规则指南 - 提供场景化的最佳实践,确保开发质量
55
globs: *
66
alwaysApply: true
77
---
88

9-
# AI 开发人机协同规则索引
9+
# 📋 CloudBase AI 开发规则指南
10+
11+
## 🎯 开发流程规范 - 场景识别与最佳实践
12+
13+
**重要:为确保开发质量,AI 需要在开始工作前完成以下步骤:**
14+
15+
### 1. 场景识别
16+
首先需要识别当前的开发场景类型:
17+
- **Web 项目**:React/Vue/原生 JS 等前端项目
18+
- **微信小程序**:小程序云开发项目
19+
- **数据库相关**:涉及数据操作的项目
20+
- **UI 设计**:需要界面设计的项目
21+
22+
### 2. 规则文件选择
23+
根据识别的场景,需要参考对应的专业规则文件:
24+
25+
**📋 场景规则映射表(必须遵守):**
26+
- **Web 项目** → 必读:`rules/web-development.mdc` + `rules/cloudbase-platform.mdc` + `rules/workflows.mdc`
27+
- **微信小程序** → 必读:`rules/miniprogram-development.mdc` + `rules/cloudbase-platform.mdc` + `rules/workflows.mdc`
28+
- **数据库操作** → 额外读:`rules/database.mdc`
29+
- **UI 设计** → 额外读:`rules/ui-design.mdc`
30+
31+
### 3. 开发确认
32+
在开始工作前建议向用户确认:
33+
1. "我识别这是一个 [场景类型] 项目"
34+
2. "我将严格遵循以下规则文件:[具体文件列表]"
35+
3. "请确认我的理解是否正确"
1036

1137
## 核心行为规则
12-
0. 你擅长调用合适的工具来完成完成各项任务,例如关于腾讯云开发相关的操作,你会优先使用 cloubase 的 mcp 来进行调用
13-
1. 你会在对话输出完毕后选择适当的时机向用户提出询问,例如是否需要添加后端能力,是否打开预览,是否需要部署等
14-
2. 你首先会阅读当前项目的 README.md,遵照当前项目的说明进行开发,如果不存在则会在生成项目后生成一个 README.md 文件
15-
3. 开发的时候,默认就在当前目录下产出所有项目代码,先检查当前目录的文件
16-
4. 开发预览的时候,如果本身项目有依赖后端数据库集合和云函数,可以优先部署后端然后再预览前端
17-
5. 交互式反馈规则:在需求不明确时主动与用户对话澄清,优先使用自动化工具 interactiveDialog 完成配置。执行高风险操作前必须使用 interactiveDialog 获得用户确认。保持消息简洁并用emoji标记状态。
18-
6. 如果涉及到实时通信相关的例如实时对战等,可以使用云开发的实时数据库 watch 能力
19-
7. **认证规则**:当用户要求实现登录注册功能时,必须严格区分平台类型:
20-
- **Web 项目**:必须使用 CloudBase Web SDK 内置的认证功能(如 `auth.toDefaultLoginPage()`),严禁使用云函数实现登录认证逻辑
21-
- **小程序项目**:小程序云开发天然免登录,在云函数中通过 wx-server-sdk 获取 `wxContext.OPENID`,严禁生成登录页面或登录流程
38+
1. **工具优先**:关于腾讯云开发的操作,优先使用 cloudbase 的 MCP 工具
39+
2. **项目理解**:首先阅读当前项目的 README.md,遵照项目说明开发
40+
3. **目录规范**:在当前目录下产出项目代码,先检查当前目录文件
41+
4. **部署顺序**:有后端依赖时,优先部署后端再预览前端
42+
5. **交互确认**:需求不明确时使用 interactiveDialog 澄清,执行高风险操作前必须确认
43+
6. **实时通信**:使用云开发的实时数据库 watch 能力
44+
7. **认证规则**:严格区分平台的认证方式
45+
- **Web 项目**:必须使用 CloudBase Web SDK 内置认证(如 `auth.toDefaultLoginPage()`)
46+
- **小程序项目**:天然免登录,云函数中获取 `wxContext.OPENID`
2247

2348
## 版本检测和升级约束
2449

@@ -31,51 +56,9 @@ alwaysApply: true
3156
### 升级指导流程
3257
- 检测到版本差异时,使用 interactiveDialog 工具与用户确认升级意愿
3358
- 提供详细的升级指导,包括 MCP 升级和 AI 规则下载两个选项
34-
- 集成官方文档链接:https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#%E5%A6%82%E4%BD%95%E6%9B%B4%E6%96%B0-cloudbase-ai-toolkit
59+
- 集成官方文档链接:https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#如何更新-cloudbase-ai-toolkit
3560
- 指导用户执行 downloadTemplate 操作,参数为 template:rules
3661

37-
### 版本信息展示格式
38-
```
39-
🚀 CloudBase AI Toolkit v{currentVersion}
40-
41-
✨ 当前版本:{currentVersion}
42-
🆕 最新版本:{latestVersion}
43-
📅 最后检查:{lastCheckTime}
44-
45-
{upgradeMessage}
46-
```
47-
48-
### 升级提示格式
49-
```
50-
🔄 发现新版本可用!
51-
52-
当前版本:{currentVersion}
53-
最新版本:{latestVersion}
54-
55-
选择升级方式:
56-
1. 🔧 升级 MCP 工具
57-
2. 📥 下载最新 AI 规则
58-
3. 🚀 全部升级
59-
4. ❌ 暂不升级
60-
61-
官方升级指南:{officialDocLink}
62-
```
63-
64-
### 首次使用欢迎信息
65-
```
66-
🎉 欢迎使用 CloudBase AI Toolkit!
67-
68-
✨ 当前版本:{currentVersion}
69-
🚀 功能特性:
70-
• 智能云开发助手
71-
• 多平台项目支持
72-
• 自动化部署流程
73-
• 丰富的项目模板
74-
75-
📚 快速开始:https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/
76-
🔄 需要了解升级流程吗?
77-
```
78-
7962
## 工作流
8063

8164
### Workflow 命令控制
@@ -131,59 +114,64 @@ alwaysApply: true
131114
```
132115
</workflow>
133116

134-
## 专业领域规则文件
117+
## 🔍 专业规则文件详细说明
135118

136-
**重要:根据具体的开发场景,AI 必须参考对应的规则文件,避免不同场景的规则互相干扰**
137-
138-
### rules/web-development.mdc
139-
描述前端+云开发 CloudBase 项目开发的专业规则,包含:
140-
- Web 项目结构和工程化配置
141-
- 静态托管部署流程
142-
- Web SDK 使用和认证方式
143-
- 适用于纯 Web 项目开发时参考
144-
145-
### rules/miniprogram-development.mdc
146-
描述微信小程序开发的专业规则,包含:
119+
### 📱 rules/miniprogram-development.mdc
120+
**强制适用**:微信小程序项目
147121
- 小程序项目结构和配置
148-
- 微信开发者工具 CLI 打开项目方法
149-
- 微信云开发能力集成
150-
- 小程序特有的 API 和权限处理
151-
- 适用于微信小程序开发时参考
152-
153-
### rules/cloudbase-platform.mdc
154-
描述 CloudBase 平台的核心知识,包含:
155-
- 云开发环境和认证
156-
- 云函数、数据库、存储等服务
157-
- 数据模型和权限管理
158-
- 控制台管理页面链接
159-
- 适用于所有使用 CloudBase 平台的项目
160-
161-
### rules/workflows.mdc
162-
描述开发工作流程,包含:
163-
- 部署流程(云函数、静态托管)
122+
- 微信开发者工具 CLI 集成
123+
- 云开发能力和 API 使用
124+
- **特别注意**:严禁使用 Web SDK 认证方式
125+
126+
### 🌐 rules/web-development.mdc
127+
**强制适用**:Web 前端项目
128+
- 现代前端工程化(Vite/Webpack)
129+
- 静态托管部署和预览
130+
- CloudBase Web SDK 集成和认证
131+
- **特别注意**:必须使用 SDK 内置认证功能
132+
133+
### ☁️ rules/cloudbase-platform.mdc
134+
**通用必读**:所有 CloudBase 项目
135+
- 云开发环境配置和认证机制
136+
- 云函数、数据库、存储服务
137+
- 数据模型和权限策略
138+
- 控制台管理链接
139+
140+
### 🔄 rules/workflows.mdc
141+
**通用必读**:项目开发各阶段
142+
- 部署流程和MCP工具调用
143+
- 文档生成和配置文件规范
164144
- 素材下载和知识库查询
165-
- 文档和配置文件生成规则
166-
- MCP 接口调用规范
167-
- 适用于项目开发的各个阶段
168-
169-
### rules/database.mdc
170-
描述云开发 CloudBase 数据库操作的专业规则,包含:
171-
- CloudBase 数据库操作注意事项
172-
- 数据库权限管理
173-
- 数据更新和错误处理
174-
- 适用于涉及数据库操作的项目
175-
176-
### rules/ui-design.mdc
177-
描述web/小程序等页面设计和 UI 规范,包含:
178-
- 高保真原型设计流程
179-
- UI 设计规范和工具选择
180-
- 前端样式处理
181-
- 适用于需要设计界面的项目
182-
183-
## 使用指导
184-
- **Web 项目开发**:主要参考 `rules/web-development.mdc` + `rules/cloudbase-platform.mdc` + `rules/workflows.mdc`
185-
- **微信小程序开发**:主要参考 `rules/miniprogram-development.mdc` + `rules/cloudbase-platform.mdc` + `rules/workflows.mdc`
186-
- **数据库相关**:额外参考 `rules/database.mdc`
187-
- **UI 设计需求**:额外参考 `rules/ui-design.mdc`
188-
189-
**重要提醒:开发微信小程序时,严禁参考 Web SDK 的认证方式,必须使用小程序专用的 API 和云开发方式!**
145+
146+
### 🗄️ rules/database.mdc
147+
**条件必读**:涉及数据库操作时
148+
- CloudBase 数据库操作规范
149+
- 权限管理和安全策略
150+
- 错误处理和数据更新
151+
152+
### 🎨 rules/ui-design.mdc
153+
**条件必读**:需要界面设计时
154+
- 高保真原型设计
155+
- UI/UX 规范和样式处理
156+
157+
## ⚡ 开发质量检查清单
158+
159+
为确保开发质量,建议在开始任务前完成以下检查:
160+
161+
### ✅ 推荐完成的步骤
162+
1. **[ ] 场景识别**:明确当前是什么类型的项目(Web/小程序/数据库/UI)
163+
2. **[ ] 规则声明**:明确列出将要遵循的规则文件清单
164+
3. **[ ] 用户确认**:向用户确认场景识别和规则选择是否正确
165+
4. **[ ] 规则执行**:严格按照选定的规则文件进行开发
166+
167+
### ⚠️ 常见问题避免
168+
- 避免跳过场景识别直接开始开发
169+
- 避免混用不同平台的 API 和认证方式
170+
- 避免忽略专业规则文件的指导
171+
- 重要技术方案建议与用户确认
172+
173+
### 🔄 质量保障
174+
如发现开发不符合规范,可以:
175+
- 指出具体问题点
176+
- 要求重新执行规则检查流程
177+
- 明确指定需要遵循的规则文件

0 commit comments

Comments
 (0)