Git提交规范

其他   2024-03-26 09:03   192   0  

一. 修改类型

每个类型值都表示了不同的含义,类型值必须是以下的其中一个:

  • feat:提交新功能

  • fix:修复了bug

  • docs:只修改了文档

  • style:调整代码格式,未修改代码逻辑(比如修改空格、格式化、缺少分号等)

  • refactor:代码重构,既没修复bug也没有添加新功能

  • perf:性能优化,提高性能的代码更改

  • test:添加或修改代码测试

  • chore:对构建流程或辅助工具和依赖库(如文档生成等)的更改

二.代码回滚

代码回滚比较特殊,如果本次提交是为了恢复到之前的某个提交,那提交消息应该以
“revert:”开头,后跟要恢复到的那个提交的标题。然后在消息正文中,应该写上“This reverts commit ”,其中“”是要还原的那个提交的SHA值。

三.影响范围

范围不是固定值,它可以是你提交代码实际影响到的任何内容。例如$location、
                              b                       r                       o                       w                       s                       e                       r                       、                            browser、            browsercompile、$rootScope、ngHref、ngClick、ngView等,唯一需要注意的是它必须足够简短。
当修改影响多个范围时,也可以使用“*”。

四.标题

标题是对变更的简明描述:

  • 使用祈使句,现在时态:是“change”不是“changed”也不是“changes”

  • 不要大写首字母

  • 结尾不要使用句号

五.正文

正文是对标题的补充,但它不是必须的。和标题一样,它也要求使用祈使句且现在时态,正文应该包含更详细的信息,如代码修改的动机,与修改前的代码对比等。

六. 页脚

任何Breaking Changes(破坏性变更,不向下兼容)都应该在页脚中进行说明,它经常也用来引用本次提交解决的GitHub Issue。
Breaking Changes应该以“BREAKING CHANGE:”开头,然后紧跟一个空格或两个换行符,其他要求与前面一致。

博客评论
还没有人评论,赶紧抢个沙发~
发表评论
说明:请文明发言,共建和谐网络,您的个人信息不会被公开显示。
闲言碎语
唯一比孤独更可怕的,是被人知道你孤独。
赞赏支持

如果觉得博客文章对您有帮助,异或土豪有钱任性,可以通过以下扫码向我捐助。也可以动动手指,帮我分享和传播。您的肯定,是我不懈努力的动力!感谢各位亲~