admin 管理员组文章数量: 1184232
约定式提交(Conventional Commits)
约定式提交(Conventional Commits)是一种为 git commit 消息定义结构化格式的规范。它为提交信息创建了一套易于遵循的规则,有助于自动生成变更日志、语义化版本控制(SemVer)以及提高团队协作效率。它起源于开源社区,并且特别受到一些流行的项目管理和开发工具的支持。Conventional Commits 官方规范。
基本格式
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
核心组成部分
1. Type(类型)
表示提交的性质,必须是以下之一:
- feat:新增功能(feature)
- fix:修复缺陷(bug fix)
- docs:文档变更
- style:代码格式调整(不影响代码运行)
- refactor:代码重构(既不修复bug也不新增功能)
- perf:性能优化
- test:测试相关变更
- build:构建系统或外部依赖变更
- ci:持续集成配置变更
- chore:其他不影响源码的变更
- revert:回滚某个提交
2. Scope(可选范围)
圆括号包围的可选部分,用于说明提交影响的范围:
feat(user-auth): add password validation
fix(api-client): handle timeout errors
3. Description(描述)
简短描述提交内容,使用现在时态:
feat: add user authentication
fix: resolve memory leak in data processor
完整示例
# 基本提交
feat:
本文标签: 定式 conventional Commits
版权声明:本文标题:约定式提交(Conventional Commits) 内容由网友自发贡献,该文观点仅代表作者本人, 转载请联系作者并注明出处:http://www.roclinux.cn/b/1763877741a3276428.html, 本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,一经查实,本站将立刻删除。
发表评论