目录
Commit 内容规范
大致分为三个部分(使用空行分割):
type commit 的类型:
示例:
常见缩写及其含义
有趣的GitMoji
示例:
Git是一款强大的版本控制工具,它可以让团队更好地协作、追踪代码变化和管理代码版本。在Git中,Commit是提交代码变更的操作,每个Commit都应该包含一些描述性的信息,以便其他开发人员了解这个Commit的目的和意义。为了让Commit信息更加规范和易于理解,许多团队都采用了特定的Commit提交规范。在本文中,我们将介绍一些常用的Git Commit提交规范,包括它们的定义、如何使用它们以及为什么采用这些规范可以帮助我们更好地管理代码。
Commit 内容规范
<type>(<scope>): <subject>
<body>
<footer>
大致分为三个部分(使用空行分割):
标题行: 必填, 描述主要修改类型和内容
主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等
页脚注释: 放 Breaking Changes 或 Closed Issues
type commit 的类型:
- feat: 新功能、新特性
- fix: 修改 bug
- perf: 更改代码,以提高性能(在不影响代码内部行为的前提下,对程序性能进行优化)
- refactor: 代码重构(重构,在不影响代码内部行为、功能下的代码修改)
- docs: 文档修改
- style: 代码格式修改, 注意不是 css 修改(例如分号修改)
- test: 测试用例新增、修改
- build: 影响项目构建或依赖项修改
- revert: 恢复上一次提交
- ci: 持续集成相关文件修改
- chore: 其他修改(不在上述类型中的修改)
- release: 发布新版本
- workflow: 工作流相关文件修改
示例:
feat: 添加网站深色模式功能
fix: 修复文章标题错误的问题
fix(global): 修复弹层层级展示问题
常见缩写及其含义
- LGTM:Looks Good To Me,表示代码经过评审后已经被确认通过;
- SGTM Sounds Good To Me ,同上
- PR:Pull Request,表示代码请求合并;
- CI:Continuous Integration,表示持续集成;
- CD:Continuous Delivery,表示持续交付;
- README:项目说明文档;
- FAQ:Frequently Asked Questions,表示常见问题解答;
- WIP:Work In Progress,表示正在进行中的工作;
- TBD:To Be Determined,表示待定的内容。
- TL;DR Too Long; Didn't Read. 太长懒得看,也有很多文档在做简略描述之前会写这么一句
有趣的GitMoji
moji
示例:
:bug: fix: 里程碑编辑权限控制修改
本文作者:BARM
本文链接:
版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA
许可协议。转载请注明出处!