常见的提交信息类型
-
feat: 引入新功能
-
fix: 修复 bug
-
docs: 更新文档
-
style: 代码风格修正（不影响代码逻辑）
-
refactor: 代码重构（不修复 bug，也不添加新功能）
-
perf: 性能优化
-
test: 添加或修复测试
-
build: 构建过程或辅助工具的变更（例如：修改构建脚本）
-
ci: 持续集成相关的变更
-
chore: 其他不属于以上类型的变更（例如：更新构建工具、依赖管理等）
-
revert: 撤销先前的提交
-
WIP: 正在进行的工作（Work In Progress）
提交信息类型示例
- feat: 添加用户登录功能
- fix: 修复用户注册时的表单验证问题
- docs: 更新 API 文档
- style: 统一代码缩进
- refactor: 优化用户信息获取逻辑
- perf: 改进数据加载性能
- test: 增加用户登录的单元测试
- chore: 更新依赖包版本
- build: 更改构建配置
- ci: 修复 CI 流程中的错误
- revert: 回退到上一个稳定版本
- WIP: 实现搜索功能（尚未完成）
提交信息格式
变更类型 (feat, fix, docs, style, refactor, perf, test, chore)
[变更类型]: 简要描述
详细描述
- 描述变更的原因和背景
- 如果有，列出影响的模块或功能
相关任务
- 任务 ID 或链接
变更前的状态
- 说明变更前的情况
变更后的状态
- 说明变更后预期的情况
注意事项
- 任何额外的注意事项或后续步骤
提交信息示例
feat: 增加用户注册功能
在注册页面添加了邮箱和密码输入字段，用户可以通过邮箱注册新账户。
相关任务
- TASK-123
变更前的状态
- 用户无法注册新账户。
变更后的状态
- 用户可以通过填写邮箱和密码成功注册新账户。
注意事项
- 需要在后台实现邮箱验证功能。
