docs(workflow): 完善 Git 工作流和版本管理文档
- 添加从 develop 创建功能分支的工作流说明 - 添加分支命名规范(feature/xxx, fix/xxx, refactor/xxx) - 添加版本自动更新规则(Semantic Versioning) - 添加 feat(version) 格式跳过版本更新的说明 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Showing
2 changed files
with
55 additions
and
1 deletions
| ... | @@ -19,6 +19,60 @@ pnpm build:weapp # 构建生产版本(微信小程序) | ... | @@ -19,6 +19,60 @@ pnpm build:weapp # 构建生产版本(微信小程序) |
| 19 | pnpm lint # 运行 ESLint | 19 | pnpm lint # 运行 ESLint |
| 20 | ``` | 20 | ``` |
| 21 | 21 | ||
| 22 | +### Git 工作流 | ||
| 23 | + | ||
| 24 | +#### 从 develop 创建功能分支 | ||
| 25 | + | ||
| 26 | +```bash | ||
| 27 | +# 1. 切换到 develop(确保最新) | ||
| 28 | +git checkout develop | ||
| 29 | +git pull | ||
| 30 | + | ||
| 31 | +# 2. 创建功能分支 | ||
| 32 | +git checkout -b feature/功能名称 | ||
| 33 | + | ||
| 34 | +# 3. 开发完成后,合并回 develop | ||
| 35 | +git checkout develop | ||
| 36 | +git merge feature/功能名称 | ||
| 37 | + | ||
| 38 | +# 4. 删除功能分支(可选) | ||
| 39 | +git branch -d feature/功能名称 | ||
| 40 | +``` | ||
| 41 | + | ||
| 42 | +**分支命名规范**: | ||
| 43 | +- `feature/xxx` - 新功能 | ||
| 44 | +- `fix/xxx` - Bug 修复 | ||
| 45 | +- `refactor/xxx` - 重构 | ||
| 46 | + | ||
| 47 | +#### 版本自动更新(已实现) | ||
| 48 | + | ||
| 49 | +**规则**:遵循 Semantic Versioning | ||
| 50 | +- `feat` - MINOR 版本更新(1.0.0 → 1.1.0) | ||
| 51 | +- `fix` - PATCH 版本更新(1.0.0 → 1.0.1) | ||
| 52 | +- `perf` - MINOR 版本更新 | ||
| 53 | +- `docs/style/refactor/test/chore` - 不更新 | ||
| 54 | + | ||
| 55 | +**实现方式**: | ||
| 56 | +- ✅ `commit-msg` hook �用 `scripts/update-version.sh` 自动更新 | ||
| 57 | +- ✅ 更新后的 `package.json` 自动加入暂存区 | ||
| 58 | +- ✅ 支持 `feat(version):` 格式跳过版本更新 | ||
| 59 | + | ||
| 60 | +**使用示例**: | ||
| 61 | +```bash | ||
| 62 | +# 在当前功能分支开发 | ||
| 63 | +git checkout -b feature/new-page | ||
| 64 | +# ... 开发代码 ... | ||
| 65 | +git add . | ||
| 66 | +git commit -m "feat(page): 添加新页面" | ||
| 67 | + | ||
| 68 | +# 合并回 develop | ||
| 69 | +git checkout develop | ||
| 70 | +git merge feature/new-page | ||
| 71 | + | ||
| 72 | +# 删除分支(可选) | ||
| 73 | +git branch -d feature/new-page | ||
| 74 | +``` | ||
| 75 | + | ||
| 22 | ### 其他平台构建 | 76 | ### 其他平台构建 |
| 23 | ```bash | 77 | ```bash |
| 24 | pnpm dev:alipay # 支付宝小程序开发 | 78 | pnpm dev:alipay # 支付宝小程序开发 | ... | ... |
-
Please register or login to post a comment