ai-engineering-init 1.1.0

package/.codex/skills/git-workflow/SKILL.md

@@ -0,0 +1,375 @@
+---
+name: git-workflow
+description: |
+  当需要进行 Git 版本控制操作时自动使用此 Skill。
+
+  触发场景：
+  - 提交代码
+  - 创建/合并分支
+  - 查看提交历史
+  - 解决冲突
+  - 回滚代码
+
+  触发词：git、提交、commit、分支、合并、push、pull、冲突、回滚、版本、历史
+---
+
+# Git 工作流指南
+
+## ⚠️ 本项目提交规范（必须遵守）
+
+### 核心原则
+
+1. **只提交当前会话的改动**：只 `git add` 当前聊天中修改或新增的文件
+2. **不提交配置文件**：排除 `.env*`、`application*.yml` 等配置
+3. **默认只提交到本地**：执行 `git add` + `git commit`，**不自动 push**
+4. **明确指定才推送**：只有用户明确说"推送"、"push"、"提交到远程"时才执行 `git push`
+
+### 提交信息格式
+
+```
+<type>(<scope>): <subject>
+```
+
+> **注意**：本项目是纯后端项目，无需平台前缀。
+
+### 提交示例
+
+```bash
+# 新功能
+feat(system): 新增用户反馈功能
+
+# 修复 Bug
+fix(demo): 修复订单状态显示错误
+
+# 文档更新
+docs(readme): 更新安装说明
+
+# 重构
+refactor(common): 重构分页查询工具类
+
+# 性能优化
+perf(system): 优化用户列表查询性能
+
+# 测试
+test(demo): 添加单元测试
+```
+
+### 提交流程
+
+```bash
+# 1. 查看当前改动
+git status
+
+# 2. 只添加当前会话修改的业务文件（排除配置）
+git add ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/xxx/
+# 或者添加具体文件
+git add path/to/file1.java path/to/file2.java
+
+# 3. 提交到本地（不 push！）
+git commit -m "feat(system): 新增xxx功能"
+
+# 4. 只有用户明确要求时才推送
+# git push  # ← 用户说"推送"时才执行
+```
+
+### 不要提交的文件
+
+```bash
+# ❌ 配置文件（绝对不提交）
+ruoyi-admin/src/main/resources/application.yml
+ruoyi-admin/src/main/resources/application-*.yml
+ruoyi-common/**/resources/*.yml
+
+# ❌ IDE 配置
+.idea/
+.vscode/
+*.iml
+
+# ❌ 本地临时文件
+*.log
+target/
+logs/
+```
+
+---
+
+## 提交类型说明
+
+| 类型 | 说明 | 示例 |
+|------|------|------|
+| feat | 新功能 | `feat(system): 新增用户反馈功能` |
+| fix | 修复Bug | `fix(demo): 修复订单状态显示错误` |
+| docs | 文档更新 | `docs(readme): 更新安装说明` |
+| style | 代码格式 | `style(system): 格式化代码` |
+| refactor | 重构 | `refactor(common): 重构用户模块` |
+| perf | 性能优化 | `perf(system): 优化查询性能` |
+| test | 测试 | `test(demo): 添加单元测试` |
+| chore | 构建/工具 | `chore: 更新依赖` |
+
+### scope 常用范围
+
+| scope | 说明 | 对应模块 |
+|-------|------|----------|
+| system | 系统管理 | `ruoyi-modules/ruoyi-system/` |
+| demo | 演示模块 | `ruoyi-modules/ruoyi-demo/` |
+| workflow | 工作流 | `ruoyi-modules/ruoyi-workflow/` |
+| job | 定时任务 | `ruoyi-modules/ruoyi-job/` |
+| generator | 代码生成 | `ruoyi-modules/ruoyi-generator/` |
+| common | 通用模块 | `ruoyi-common/` |
+| admin | 启动模块 | `ruoyi-admin/` |
+
+---
+
+## 常用命令
+
+### 基础操作
+
+```bash
+# 查看状态
+git status
+
+# 查看改动
+git diff
+git diff --staged  # 已暂存的改动
+
+# 添加文件
+git add .          # 添加所有（谨慎使用！）
+git add <file>     # 添加指定文件（推荐）
+
+# 提交
+git commit -m "提交信息"
+
+# 推送（需用户明确要求）
+git push
+git push -u origin <branch>  # 首次推送并设置上游
+```
+
+### 分支操作
+
+```bash
+# 查看分支
+git branch         # 本地分支
+git branch -r      # 远程分支
+git branch -a      # 所有分支
+
+# 创建分支
+git branch <name>
+git checkout -b <name>  # 创建并切换
+
+# 切换分支
+git checkout <name>
+git switch <name>
+
+# 合并分支
+git merge <name>
+
+# 删除分支
+git branch -d <name>     # 删除本地
+git push origin -d <name>  # 删除远程
+```
+
+### 历史查看
+
+```bash
+# 查看提交历史
+git log
+git log --oneline
+git log --oneline -10  # 最近10条
+
+# 查看某文件历史
+git log --follow <file>
+
+# 查看某次提交的内容
+git show <commit-id>
+```
+
+### 撤销操作
+
+```bash
+# 撤销工作区修改
+git checkout -- <file>
+git restore <file>
+
+# 撤销暂存
+git reset HEAD <file>
+git restore --staged <file>
+
+# 撤销提交（保留修改）
+git reset --soft HEAD^
+
+# 撤销提交（丢弃修改）
+git reset --hard HEAD^
+
+# 回滚到某个提交
+git reset --hard <commit-id>
+```
+
+---
+
+## 分支策略
+
+### 主要分支
+
+| 分支 | 用途 | 说明 |
+|------|------|------|
+| 5.X | 主分支 | 生产/发布代码（本项目主分支） |
+| dev | 开发分支 | 日常开发代码 |
+| feature/* | 功能分支 | 新功能开发 |
+| fix/* | 修复分支 | Bug修复 |
+| release/* | 发布分支 | 版本发布 |
+
+### 工作流程
+
+```bash
+# 1. 从 dev 创建功能分支
+git checkout dev
+git pull
+git checkout -b feature/user-feedback
+
+# 2. 开发并提交（只提交当前会话改动的业务文件）
+git add ruoyi-modules/ruoyi-system/src/main/java/org/dromara/system/feedback/
+git commit -m "feat(system): 新增用户反馈功能"
+
+# 3. 用户明确要求时才推送到远程
+git push -u origin feature/user-feedback
+
+# 4. 创建 Pull Request 合并到 dev
+
+# 5. 合并后删除功能分支
+git checkout dev
+git pull
+git branch -d feature/user-feedback
+```
+
+---
+
+## 冲突解决
+
+### 合并冲突
+
+```bash
+# 1. 拉取最新代码
+git pull
+
+# 2. 如果有冲突，Git 会提示
+# Auto-merging xxx.java
+# CONFLICT (content): Merge conflict in xxx.java
+
+# 3. 打开冲突文件，手动解决
+# <<<<<<< HEAD
+# 当前分支的代码
+# =======
+# 要合并的代码
+# >>>>>>> feature/xxx
+
+# 4. 解决后添加并提交
+git add .
+git commit -m "fix: 解决合并冲突"
+```
+
+### 变基冲突
+
+```bash
+# 1. 变基
+git rebase dev
+
+# 2. 如果有冲突，解决后
+git add .
+git rebase --continue
+
+# 3. 放弃变基
+git rebase --abort
+```
+
+---
+
+## 实用技巧
+
+### 暂存修改
+
+```bash
+# 暂存当前修改
+git stash
+
+# 查看暂存列表
+git stash list
+
+# 恢复暂存
+git stash pop        # 恢复并删除
+git stash apply      # 恢复但保留
+
+# 删除暂存
+git stash drop
+git stash clear      # 清空所有
+```
+
+### 修改提交
+
+```bash
+# 修改最后一次提交信息
+git commit --amend -m "新的提交信息"
+
+# 追加到最后一次提交
+git add .
+git commit --amend --no-edit
+```
+
+### Cherry-pick
+
+```bash
+# 把某个提交应用到当前分支
+git cherry-pick <commit-id>
+```
+
+### 查看某人的提交
+
+```bash
+git log --author="作者名"
+```
+
+---
+
+## 注意事项
+
+### 禁止操作
+
+1. **不要强制推送到主分支**
+   ```bash
+   # ❌ 禁止
+   git push --force origin 5.X
+   ```
+
+2. **不要在主分支直接开发**
+   ```bash
+   # ❌ 禁止
+   git checkout 5.X
+   # 直接修改代码...
+   ```
+
+3. **不要提交敏感信息和配置文件**
+   ```bash
+   # ❌ 禁止提交
+   application.yml
+   application-dev.yml
+   application-prod.yml
+   credentials.json
+   password.txt
+   ```
+
+4. **不要自动 push（除非用户明确要求）**
+   ```bash
+   # ❌ 默认不执行
+   git push
+
+   # ✅ 只有用户说"推送到远程"时才执行
+   git push
+   ```
+
+### 最佳实践
+
+1. **只提交当前会话改动**：不要 `git add .`，精确添加修改的文件
+2. **排除配置文件**：配置文件包含本地环境信息，不应提交
+3. **清晰的提交信息**：包含类型 + 范围 + 描述
+4. **默认只本地提交**：`git add` + `git commit`，不自动 push
+5. **频繁小步提交**：便于追踪和回滚
+6. **Code Review**：通过 PR 合并代码

package/.codex/skills/init-docs/SKILL.md

@@ -0,0 +1,194 @@
+---
+name: init-docs
+description: |
+  当需要为项目初始化文档体系、创建项目文档时自动使用此 Skill。
+
+  触发场景：
+  - 新项目第一次初始化文档体系
+  - 现有文档丢失或需要重新组织
+  - 新成员加入，需要统一文档格式
+  - 根据最新代码重新生成文档
+
+  触发词：初始化文档、init-docs、文档初始化、创建文档、项目文档、文档体系
+---
+
+# /init-docs - 项目文档初始化
+
+为纯后端 RuoYi-Vue-Plus 项目初始化完整的项目文档体系。支持空白模板或基于现有代码智能生成。
+
+---
+
+## 🎯 适用场景
+
+| 场景 | 说明 |
+|------|------|
+| **项目启动** | 新项目第一次初始化文档体系 |
+| **文档重建** | 现有文档丢失或需要重新组织 |
+| **团队协作** | 新成员加入，需要统一文档格式 |
+| **定期整理** | 根据最新代码重新生成文档 |
+
+---
+
+## 📋 执行模式
+
+### 模式 1：空白模板（默认）
+
+```bash
+/init-docs
+```
+
+创建空白文档结构，适合新项目或想从零开始规划的项目。
+
+### 模式 2：智能扫描
+
+```bash
+/init-docs --scan
+```
+
+扫描现有代码并智能生成文档，自动分析项目结构和代码完整度。
+
+---
+
+## 🚀 执行流程
+
+### 第一步：确认初始化模式
+
+```
+请选择初始化方式：
+1. 空白模板（推荐新项目）
+2. 扫描现有代码（推荐已有代码）
+```
+
+### 第二步：创建目录结构
+
+```bash
+mkdir -p docs
+```
+
+**生成的目录结构**：
+```
+项目根目录/
+└── docs/
+    ├── README.md                 # 项目简介
+    ├── ARCHITECTURE.md           # 架构说明
+    ├── PROJECT_STATUS.md         # 项目进度
+    ├── TODO.md                   # 待办清单
+    └── CHANGELOG.md              # 变更日志
+```
+
+### 第三步：扫描代码（仅在 --scan 模式）
+
+```bash
+# 查找所有业务模块
+Glob pattern: "ruoyi-modules/ruoyi-*/src/main/java/**/controller/*Controller.java"
+```
+
+### 第四步：生成文档内容
+
+根据扫描或手动输入的信息生成文档。
+
+---
+
+## 生成的文档模板
+
+### docs/README.md
+
+```markdown
+# 项目名称
+
+## 📋 项目简介
+
+**项目名**：RuoYi-Vue-Plus 纯后端版
+**技术栈**：
+- **后端框架**：Spring Boot 3.x
+- **ORM框架**：MyBatis-Plus 3.x
+- **权限框架**：Sa-Token
+- **数据库**：MySQL 8.0+
+
+## 🚀 快速开始
+
+1. 克隆项目
+2. 导入数据库
+3. 修改数据库配置
+4. 运行后端服务
+
+## 📖 文档导航
+
+- [📊 项目进度](./PROJECT_STATUS.md)
+- [🏗️ 架构说明](./ARCHITECTURE.md)
+- [📝 待办清单](./TODO.md)
+- [📝 变更日志](./CHANGELOG.md)
+```
+
+### docs/PROJECT_STATUS.md
+
+```markdown
+# 📊 项目进度报告
+
+**报告生成时间**：YYYY-MM-DD
+**项目状态**：🟢 开发中
+
+## 概览
+
+| 指标 | 值 | 说明 |
+|------|-----|------|
+| 总功能数 | X | 规划的功能总数 |
+| 已完成 | X | 100% 完成的功能 |
+| 进行中 | X | 50-99% 的功能 |
+| 待开发 | X | 0% 的功能 |
+```
+
+### docs/TODO.md
+
+```markdown
+# 📝 待办清单
+
+**最后更新**：YYYY-MM-DD
+
+## 🔴 高优先级（本周必做）
+
+- [ ] [任务描述]
+
+## 🟡 中优先级（本月完成）
+
+- [ ] [任务描述]
+
+## 🟢 低优先级（有时间做）
+
+- [ ] [任务描述]
+
+## ✅ 已完成
+
+- [x] [任务描述] - 完成于 YYYY-MM-DD
+```
+
+---
+
+## 第五步：输出初始化报告
+
+```markdown
+# ✅ 项目文档初始化完成！
+
+**初始化时间**：YYYY-MM-DD HH:mm
+
+## 📂 已创建的文件
+
+| 文件 | 说明 | 位置 |
+|------|------|------|
+| README.md | 项目简介 | docs/README.md |
+| PROJECT_STATUS.md | 项目进度 | docs/PROJECT_STATUS.md |
+| ARCHITECTURE.md | 架构说明 | docs/ARCHITECTURE.md |
+| TODO.md | 待办清单 | docs/TODO.md |
+| CHANGELOG.md | 变更日志 | docs/CHANGELOG.md |
+
+## 🎯 下一步建议
+
+### 1️⃣ 快速了解项目
+\`/start\`
+
+### 2️⃣ 查看详细进度
+\`/progress\`
+
+### 3️⃣ 检查代码规范
+\`/check\`
+```