feat(ai-skills): 添加 AI 全局技能库
创建 ai-skills/ 目录,包含所有 AI 助手共享的技能规范: - gitea-api.md: Gitea API 使用指南 - issue-workflow.md: 工单处理标准流程 - menu-config.md: 菜单配置规范 - commit-standards.md: 提交规范 - README.md: 使用说明
This commit is contained in:
@@ -0,0 +1,28 @@
|
|||||||
|
# AI 全局技能库
|
||||||
|
|
||||||
|
> 所有 AI 助手共享的技能和流程规范
|
||||||
|
> 通过 git submodule 引用到各项目中
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
ai-skills/
|
||||||
|
├── README.md # 本说明
|
||||||
|
├── issue-workflow.md # 工单处理流程
|
||||||
|
├── gitea-api.md # Gitea API 使用指南
|
||||||
|
├── menu-config.md # 菜单配置规范
|
||||||
|
└── commit-standards.md # 提交规范
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用方式
|
||||||
|
|
||||||
|
各项目通过 submodule 引用后,AI 可在以下路径读取:
|
||||||
|
```
|
||||||
|
项目/docs/shared/ai-skills/
|
||||||
|
```
|
||||||
|
|
||||||
|
## 更新流程
|
||||||
|
|
||||||
|
1. 在 rui-docs 仓库修改全局技能
|
||||||
|
2. 提交并推送到远程
|
||||||
|
3. 各项目执行 `git submodule update --remote` 获取更新
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
# 提交规范
|
||||||
|
|
||||||
|
## 语义化前缀
|
||||||
|
|
||||||
|
| 前缀 | 说明 | 示例 |
|
||||||
|
|------|------|------|
|
||||||
|
| `feat:` | 新功能 | feat(menu): 添加收银系统菜单 |
|
||||||
|
| `fix:` | 修复问题 | fix(order): 修复订单计算错误 |
|
||||||
|
| `docs:` | 文档更新 | docs: 更新 README |
|
||||||
|
| `chore:` | 杂项 | chore: 更新依赖版本 |
|
||||||
|
| `test:` | 测试相关 | test: 添加单元测试 |
|
||||||
|
| `refactor:` | 重构 | refactor: 优化查询逻辑 |
|
||||||
|
|
||||||
|
## 提交信息格式
|
||||||
|
|
||||||
|
```
|
||||||
|
<type>(<scope>): <subject>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<footer>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 关联工单
|
||||||
|
|
||||||
|
在提交信息中关联工单:
|
||||||
|
```
|
||||||
|
feat(menu): 添加收银系统菜单配置
|
||||||
|
|
||||||
|
- 新增 cashier.json 菜单配置文件
|
||||||
|
- 包含6个子菜单
|
||||||
|
|
||||||
|
对应工单 #2
|
||||||
|
```
|
||||||
|
|
||||||
|
## 推送命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 远程名称是 gitea,不是 origin
|
||||||
|
git push gitea main
|
||||||
|
```
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
# Gitea API 使用指南
|
||||||
|
|
||||||
|
## Token 位置
|
||||||
|
|
||||||
|
```
|
||||||
|
~/.config/gitea/token
|
||||||
|
```
|
||||||
|
|
||||||
|
## 获取 Issue
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -s -H "Authorization: token $(cat ~/.config/gitea/token)" \
|
||||||
|
"https://git.dev.vifo.cc/api/v1/repos/{owner}/{repo}/issues/{id}"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 回复 Issue 评论
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -s -X POST \
|
||||||
|
-H "Authorization: token $(cat ~/.config/gitea/token)" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"body": "评论内容"}' \
|
||||||
|
"https://git.dev.vifo.cc/api/v1/repos/{owner}/{repo}/issues/{id}/comments"
|
||||||
|
```
|
||||||
|
|
||||||
|
**注意**: JSON 内容需要转义换行符
|
||||||
|
|
||||||
|
## 常用端点
|
||||||
|
|
||||||
|
| 操作 | 端点 |
|
||||||
|
|------|------|
|
||||||
|
| 获取 Issue | `GET /api/v1/repos/{owner}/{repo}/issues/{id}` |
|
||||||
|
| 创建评论 | `POST /api/v1/repos/{owner}/{repo}/issues/{id}/comments` |
|
||||||
|
| 获取仓库 | `GET /api/v1/repos/{owner}/{repo}` |
|
||||||
|
|
||||||
|
## Git 远程地址
|
||||||
|
|
||||||
|
```
|
||||||
|
gitea ssh://git@git.dev.vifo.cc:222/rui/{repo}.git
|
||||||
|
```
|
||||||
|
|
||||||
|
**推送命令**: `git push gitea main`(注意不是 origin)
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
# 工单处理流程
|
||||||
|
|
||||||
|
## 标准流程
|
||||||
|
|
||||||
|
### 1. 获取工单详情
|
||||||
|
|
||||||
|
使用 Gitea API 获取 Issue 内容:
|
||||||
|
```bash
|
||||||
|
curl -s -H "Authorization: token $(cat ~/.config/gitea/token)" \
|
||||||
|
"https://git.dev.vifo.cc/api/v1/repos/{owner}/{repo}/issues/{id}"
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. 分析需求
|
||||||
|
|
||||||
|
- 阅读工单标题和描述
|
||||||
|
- 确认需求范围
|
||||||
|
- 检查相关配置文件和代码
|
||||||
|
- 必要时向用户澄清
|
||||||
|
|
||||||
|
### 3. 实施修改
|
||||||
|
|
||||||
|
按 Superpowers 工作流处理:
|
||||||
|
- 简单任务:直接实施
|
||||||
|
- 复杂任务:设计 -> 计划 -> 实施
|
||||||
|
|
||||||
|
### 4. 回复工单状态
|
||||||
|
|
||||||
|
完成后必须回复工单:
|
||||||
|
```bash
|
||||||
|
curl -s -X POST \
|
||||||
|
-H "Authorization: token $(cat ~/.config/gitea/token)" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"body": "✅ 已完成\n\n完成内容..."}' \
|
||||||
|
"https://git.dev.vifo.cc/api/v1/repos/{owner}/{repo}/issues/{id}/comments"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 提交规范
|
||||||
|
|
||||||
|
- 提交信息需关联工单编号:`对应工单 #2`
|
||||||
|
- 使用语义化提交前缀:`feat:`, `fix:`, `docs:`, `chore:`
|
||||||
|
|
||||||
|
## 优先级处理
|
||||||
|
|
||||||
|
| 优先级 | 标识 | 处理时效 |
|
||||||
|
|--------|------|----------|
|
||||||
|
| P0 | 紧急 | 立即处理 |
|
||||||
|
| P1 | 高 | 当天完成 |
|
||||||
|
| P2 | 中 | 2-3天内 |
|
||||||
|
| P3 | 低 | 排期处理 |
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
# 菜单配置规范
|
||||||
|
|
||||||
|
## 配置目录
|
||||||
|
|
||||||
|
```
|
||||||
|
~/rhkj/spring-ai/config/menus/
|
||||||
|
```
|
||||||
|
|
||||||
|
## 文件命名
|
||||||
|
|
||||||
|
- `{模块编码}.json`
|
||||||
|
- 示例:`cashier.json`, `system.json`, `user.json`
|
||||||
|
|
||||||
|
## 文件格式
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "模块编码(与文件名一致)",
|
||||||
|
"menus": [
|
||||||
|
{
|
||||||
|
"code": "菜单编码",
|
||||||
|
"name": "菜单名称",
|
||||||
|
"type": 1,
|
||||||
|
"icon": "tabler:图标名",
|
||||||
|
"sortNo": 0,
|
||||||
|
"children": [
|
||||||
|
{
|
||||||
|
"code": "子菜单编码",
|
||||||
|
"name": "子菜单名称",
|
||||||
|
"type": 2,
|
||||||
|
"icon": "tabler:图标名",
|
||||||
|
"path": "/路由路径",
|
||||||
|
"permission": "权限标识",
|
||||||
|
"sortNo": 1,
|
||||||
|
"buttons": [
|
||||||
|
{
|
||||||
|
"code": "btn:add",
|
||||||
|
"name": "新增",
|
||||||
|
"permission": "模块:功能:add"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 字段说明
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `code` | string | ✅ | 菜单编码,唯一标识 |
|
||||||
|
| `name` | string | ✅ | 菜单显示名称 |
|
||||||
|
| `type` | int | ✅ | 1=目录, 2=菜单, 3=按钮 |
|
||||||
|
| `icon` | string | ✅ | 图标(tabler: 前缀) |
|
||||||
|
| `path` | string | 菜单必填 | 路由路径 |
|
||||||
|
| `permission` | string | ✅ | 权限标识 |
|
||||||
|
| `sortNo` | int | ✅ | 排序号,越小越靠前 |
|
||||||
|
| `children` | array | 可选 | 子菜单列表 |
|
||||||
|
| `buttons` | array | 可选 | 按钮权限列表 |
|
||||||
|
|
||||||
|
## 初始化方式
|
||||||
|
|
||||||
|
- 由**超级租户**读取 JSON 配置并初始化到数据库
|
||||||
|
- 不需要编写 SQL 脚本或 Java 初始化代码
|
||||||
|
- 修改 JSON 后提交到 spring-ai 仓库即可
|
||||||
Reference in New Issue
Block a user