ai-engineering-init 1.6.0 → 1.8.0

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

@@ -1,397 +1,179 @@
 ---
 name: git-workflow
 description: |
-  当需要进行 Git 版本控制操作时自动使用此 Skill。
-
-  触发场景：
-  - 提交代码
-  - 创建/合并分支
-  - 查看提交历史
-  - 解决冲突
-  - 回滚代码
-
-  触发词：git、提交、commit、分支、合并、push、pull、冲突、回滚、版本、历史
+  通用 Git 工作流指南。涵盖分支策略、提交规范、PR 流程、冲突解决等。
+  触发场景：Git 操作、分支管理、提交规范、代码合并。
+  触发词：Git、分支、提交、合并、rebase、PR。
+  注意：如果项目有专属技能（如 `leniu-git-workflow`），优先使用专属版本。
 ---
 
 # Git 工作流指南
 
-## ⚠️ 本项目提交规范（必须遵守）
+> 通用模板。如果项目有专属技能（如 `leniu-git-workflow`），优先使用。
 
-### 核心原则
+## 核心规范
 
-1. **只提交当前会话的改动**：只 `git add` 当前聊天中修改或新增的文件
-2. **不提交配置文件**：排除 `.env*`、`application*.yml` 等配置
-3. **默认只提交到本地**：执行 `git add` + `git commit`，**不自动 push**
-4. **明确指定才推送**：只有用户明确说"推送"、"push"、"提交到远程"时才执行 `git push`
-
-### 提交信息格式
+### 分支策略（Git Flow）
 
 ```
-<type>(<scope>): <subject>
+main (production)
+│
+├── hotfix/fix-payment-bug     ← 紧急修复，从 main 拉出
+│
+develop (integration)
+│
+├── feature/order-export       ← 功能开发，从 develop 拉出
+├── feature/user-profile       ← 并行开发
+│
+└── release/v1.2.0             ← 发布准备，从 develop 拉出
 ```
 
-> **注意**：本项目是纯后端项目，无需平台前缀。
-
-### 提交示例
-
-```bash
-# 新功能
-feat(system): 新增用户反馈功能
-
-# 修复 Bug
-fix(demo): 修复订单状态显示错误
-
-# 文档更新
-docs(readme): 更新安装说明
-
-# 重构
-refactor(common): 重构分页查询工具类
-
-# 性能优化
-perf(system): 优化用户列表查询性能
-
-# 测试
-test(demo): 添加单元测试
-```
+| 分支类型 | 来源 | 合并目标 | 命名 |
+|---------|------|---------|------|
+| `main` | - | - | `main` |
+| `develop` | `main` | `main` | `develop` |
+| `feature/*` | `develop` | `develop` | `feature/功能描述` |
+| `release/*` | `develop` | `main` + `develop` | `release/v1.x.x` |
+| `hotfix/*` | `main` | `main` + `develop` | `hotfix/问题描述` |
 
-### 提交流程
-
-```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
-# ❌ 团队项目配置文件（绝对不提交，包含数据库/中间件/环境信息）
-core-base/src/main/resources/bootstrap.yml
-core-base/src/main/resources/bootstrap-dev.yml
-core-base/src/main/resources/ConfigSource.properties
-core-base/src/main/resources/license.dat
-core-base/src/main/resources/logback-spring.xml
-core-base/src/main/resources/message_*.properties
-
-# ❌ 通用配置文件（绝对不提交）
-ruoyi-admin/src/main/resources/application.yml
-ruoyi-admin/src/main/resources/application-*.yml
-ruoyi-common/**/resources/*.yml
-
-# ❌ 测试/迁移基础设施文件（包含本地数据源配置，不提交）
-**/WebMvcTestConfig.java
-**/DataSourceMigration.java
-
-# ❌ IDE 配置
-.idea/
-.vscode/
-*.iml
+### 简化策略（GitHub Flow，适合小团队）
 
-# ❌ 本地临时文件
-*.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>  # 首次推送并设置上游
+main
+├── feature/order-export
+├── fix/login-error
+└── chore/upgrade-deps
 ```
 
-### 分支操作
-
-```bash
-# 查看分支
-git branch         # 本地分支
-git branch -r      # 远程分支
-git branch -a      # 所有分支
-
-# 创建分支
-git branch <name>
-git checkout -b <name>  # 创建并切换
-
-# 切换分支
-git checkout <name>
-git switch <name>
+- 只有 `main` 一个长期分支
+- 所有开发从 `main` 拉分支，完成后通过 PR 合并回 `main`
 
-# 合并分支
-git merge <name>
+### 提交规范（Conventional Commits）
 
-# 删除分支
-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>
+<type>(<scope>): <subject>
 ```
 
----
-
-## 分支策略
-
-### 主要分支
-
-| 分支 | 用途 | 说明 |
+| type | 说明 | 示例 |
 |------|------|------|
-| 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): 新增用户反馈功能"
+| `feat` | 新功能 | `feat(order): 新增订单导出` |
+| `fix` | 修复 Bug | `fix(auth): 修复 token 过期未刷新` |
+| `docs` | 文档 | `docs: 更新 API 文档` |
+| `style` | 格式 | `style: 统一缩进为 4 空格` |
+| `refactor` | 重构 | `refactor(user): 拆分用户服务` |
+| `perf` | 性能 | `perf(query): 优化列表查询 N+1` |
+| `test` | 测试 | `test(order): 补充订单创建单测` |
+| `chore` | 构建/工具 | `chore: 升级 Spring Boot 3.2` |
+| `ci` | CI/CD | `ci: 添加 GitHub Actions 流水线` |
 
-# 3. 用户明确要求时才推送到远程
-git push -u origin feature/user-feedback
+**规则**：
+- subject 使用中文或英文，但全项目统一
+- 不超过 72 字符
+- 不以句号结尾
+- 使用祈使语气（"添加"而非"添加了"）
 
-# 4. 创建 Pull Request 合并到 dev
+### 提交行为规范
 
-# 5. 合并后删除功能分支
-git checkout dev
-git pull
-git branch -d feature/user-feedback
-```
-
----
+1. **只提交当前会话的改动**：精确 `git add` 修改的文件，不要 `git add .`
+2. **不提交配置文件**：排除 `.env*`、`application-*.yml` 等环境配置
+3. **默认只提交到本地**：执行 `git add` + `git commit`，不自动 push
+4. **明确指定才推送**：只有用户明确说"推送"、"push"时才执行 `git push`
 
-## 冲突解决
+## 代码示例
 
-### 合并冲突
+### 常用 Git 操作
 
 ```bash
-# 1. 拉取最新代码
-git pull
+# 创建功能分支
+git checkout develop
+git pull origin develop
+git checkout -b feature/order-export
 
-# 2. 如果有冲突，Git 会提示
-# Auto-merging xxx.java
-# CONFLICT (content): Merge conflict in xxx.java
+# 开发完成，合并前更新
+git fetch origin
+git rebase origin/develop
 
-# 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
+# 推送并创建 PR
+git push -u origin feature/order-export
+gh pr create --base develop --title "feat(order): 新增订单导出功能"
 ```
 
----
+### 常用 Git 修复操作
 
-## 实用技巧
+```bash
+# 修改最后一次提交信息
+git commit --amend -m "fix(order): 修复订单金额计算"
 
-### 暂存修改
+# 撤销最后一次提交（保留修改）
+git reset --soft HEAD~1
 
-```bash
 # 暂存当前修改
 git stash
+git stash pop
 
-# 查看暂存列表
-git stash list
-
-# 恢复暂存
-git stash pop        # 恢复并删除
-git stash apply      # 恢复但保留
+# 挑选某个提交到当前分支
+git cherry-pick <commit-hash>
 
-# 删除暂存
-git stash drop
-git stash clear      # 清空所有
+# 查看某个文件的修改历史
+git log --oneline -20 -- path/to/file
 ```
 
-### 修改提交
+### PR / Code Review 规范
 
-```bash
-# 修改最后一次提交信息
-git commit --amend -m "新的提交信息"
+1. **PR 大小**：单个 PR 不超过 400 行变更（不含自动生成代码）
+2. **PR 描述**：说明改了什么、为什么改、如何测试
+3. **自查清单**：
+   - [ ] 代码能编译通过
+   - [ ] 新功能有对应测试
+   - [ ] 没有遗留 TODO / 调试代码
+   - [ ] 数据库变更有迁移脚本
+4. **Review 要点**：
+   - 逻辑正确性 > 代码风格
+   - 关注边界条件和异常处理
+   - 检查安全隐患（SQL 注入、XSS 等）
 
-# 追加到最后一次提交
-git add .
-git commit --amend --no-edit
-```
+### .gitignore 推荐配置
 
-### Cherry-pick
+```gitignore
+# IDE
+.idea/
+*.iml
+.vscode/
+*.swp
 
-```bash
-# 把某个提交应用到当前分支
-git cherry-pick <commit-id>
-```
+# Build
+target/
+build/
+dist/
+node_modules/
 
-### 查看某人的提交
+# Environment
+.env
+.env.local
+*.local
 
-```bash
-git log --author="作者名"
+# OS
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+logs/
 ```
 
----
+## 常见错误
 
-## 注意事项
-
-### 禁止操作
-
-1. **不要强制推送到主分支**
-   ```bash
-   # ❌ 禁止（团队主分支为 master）
-   git push --force origin master
-   git push --force origin main
-   ```
-
-2. **不要在主分支直接开发**
-   ```bash
-   # ❌ 禁止（团队主分支为 master，不在此分支直接提交）
-   git checkout master
-   # 直接修改代码...
-   ```
-
-3. **不要提交敏感信息和配置文件**
-   ```bash
-   # ❌ 禁止提交
-   application.yml
-   application-dev.yml
-   application-prod.yml
-   bootstrap.yml
-   bootstrap-dev.yml
-   ConfigSource.properties
-   license.dat
-   logback-spring.xml
-   message_*.properties
-   credentials.json
-   password.txt
-   # ❌ 禁止提交（包含本地数据源/测试环境配置）
-   WebMvcTestConfig.java
-   DataSourceMigration.java
-   ```
-
-4. **不要自动 push（除非用户明确要求）**
-   ```bash
-   # ❌ 默认不执行
-   git push
-
-   # ✅ 只有用户说"推送到远程"时才执行
-   git push
-   ```
-
-### 最佳实践
-
-1. **只提交当前会话改动**：不要 `git add .`，精确添加修改的文件
-2. **排除配置文件**：配置文件包含本地环境信息，不应提交
-3. **清晰的提交信息**：包含类型 + 范围 + 描述
-4. **默认只本地提交**：`git add` + `git commit`，不自动 push
-5. **频繁小步提交**：便于追踪和回滚
-6. **Code Review**：通过 PR 合并代码
+| 错误 | 正确做法 |
+|------|---------|
+| 直接在 main 上开发 | 创建功能分支 |
+| 提交信息写"update"、"fix bug" | 按 Conventional Commits 规范 |
+| 一个 PR 包含多个不相关改动 | 拆分为多个 PR |
+| `git push --force` 到公共分支 | 只对个人分支 force push |
+| 提交 .env、密钥文件 | 加入 .gitignore |
+| merge 前不更新目标分支 | 先 rebase/merge 最新代码 |
+| 忽略 CI 失败直接合并 | 修复 CI 后再合并 |
+| `git add .` 一把梭 | 精确添加修改的业务文件 |