约定式提交规范
本 skill 遵循约定式提交(Conventional Commits)规范进行提交信息格式化。
格式
<类型>: <标题>
<正文描述>正文(body)是必填项,用于补充变更的具体内容和原因。正文应列出关键变更点,使用列表格式(- 开头)。
支持的类型
| 类型 | 描述 |
|---|---|
docs |
文档变更 |
feat |
新功能 |
fix |
Bug 修复 |
refactor |
代码重构 |
style |
代码风格变更 |
chore |
构建工具、依赖、工具链 |
test |
测试添加或修改 |
config |
配置变更 |
license |
License 文件更新 |
示例
docs: 更新 README 文档
- 补充安装说明
- 添加使用示例
feat: 添加用户认证
- 实现 JWT Token 签发与验证
- 添加登录/登出 API 端点
fix: 修复解析器内存泄漏
- 修复大文件解析时缓冲区未释放的问题
chore: 更新依赖Issue / Task 引用
git-batch-commit 只负责轻量引用,不负责关闭 Issue:
docs: 更新 README 文档 (#13)
Refs #13
- 补充安装说明
- 添加使用示例项目本地任务引用使用正文中的 Refs:,避免误关 GitHub Issue:
docs: 更新任务材料
Refs: project-task Issue #13
- 补充素材包说明若需要使用 Closes #N 关闭 GitHub Issue,或需要合并 PR、推送远端、拉取 PR 到 main,遵循 git-workflow。
为什么要使用标准化提交?
- 更易阅读: 快速理解改动内容
- 更好的 git log: 更清晰、更有意义的历史记录
- 自动化 changelog: 工具可以自动生成 CHANGELOG.md
- 语义化版本控制: 帮助确定版本升级
- 团队一致性: 所有人使用相同的格式