废话只说一句:码字不易求个👍,收藏 === 学会,快行动起来吧!🙇🙇🙇。
在工作中避免不了多人协作,协作避免不了有一个规范的流程,让大家有效的去合作;让项目有条不紊的进行。自然使用 git 规范进行把控也是项目中必不可少的技术了。
Git commit 规范
为什么要写好 Git Commit?
- 提供更多的历史信息,方便快速浏览
- 可以过滤某些commit(比如文档改动),方便快速查找信息
# 过滤日志信息git log HEAD --pretty=format:%s --grep 关键字
- 可以直接从commit生成Change log
如何写好Git Commit
业界使用比较广泛的是Angular规范
<type>(<scope>):<subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
- 标题行:必填,描述主要修改类型和内容
- 主要内容:描述为什么修改,做什么样的修改,以及开发的思路等等
- 页脚注释:放 Breaking Changes 或 Closed Issuses
type | commit 类型
类型 | 详细介绍 |
---|---|
feat | 新功能、新特性 |
fix | bugfix,修改问题 |
refactor | 代码重构 |
docs | 文档修改 |
style | 代码格式修改,注意不是css修改 |
test | 测试用例修改 |
chore | 其他修改,比如构建,依赖管理 |