名称:git-workflow 描述:遵循git提交、分支和PR的约定。 在git操作期间自动激活。
Git 工作流程技能
目的
确保在所有阶段一致的git实践。
提交消息约定
参考:conventions/commit-messages.md
格式
<type>(<scope>): <subject>
[optional body]
[optional footer]
类型
| Type | Use For |
|---|---|
| feat | 新功能 |
| fix | 错误修复 |
| refactor | 代码重构 |
| docs | 文档 |
| test | 测试更改 |
| chore | 维护 |
| perf | 性能改进 |
| style | 格式化,无代码更改 |
| ci | CI/CD 更改 |
示例
feat(auth): 实现 JWT token 刷新
- 添加刷新token端点
- 更新token验证逻辑
- 添加集成测试
Closes #123
分支命名
参考:conventions/branch-naming.md
格式:<type>/<ticket>-<description>
示例:
feat/AUTH-123-jwt-refreshfix/BUG-456-login-errorrefactor/TECH-789-user-service
PR 模板
工作流程最佳实践
提交频率
- 在每个逻辑工作单元后提交
- 每个提交应该独立可构建
- 不要提交损坏的代码
分支策略
- 从main/develop创建功能分支
- 保持分支短期存活
- 在适当情况下合并前rebase
PR 指南
- 保持PR专注和可审查
- 在描述中包含上下文
- 链接到相关问题
- 请求适当的评审者
质量检查清单
提交前:
- [ ] 代码编译/构建通过
- [ ] 测试通过
- [ ] Lint通过
- [ ] 提交消息遵循约定
- [ ] 未包含敏感数据
创建PR前:
- [ ] 分支是最新的
- [ ] 所有提交有意义
- [ ] PR描述完整
- [ ] 包括测试
- [ ] 文档已更新