Git commit规范(angular)
Git commit规范(angular)
常用git命令
git init
git remote add origin [仓库地址]
git add .
git commit –m “”
git push origin [branch]
每次进行git提交时,需要写提交说明,规范提交说明的好处如下
更加结构化的提交历史
保证每次信息都有确切的含义
方便直接生成changelog
方便信息搜索和过滤
目前最受开发人员肯定的规范是前端框架Angular提出的Angular提交信息规范
其提交格式如下:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。其中,Header 是必需的,Body 和 Footer 可以省略。
Header
(1)type
提交类型指定为下面其中一个:
build:对构建系统或者外部依赖项进行了修改
ci:对CI配置文件或脚本进行了修改
docs:对文档进行了修改
feat:增加新的特征
fix:修复bug
pref:提高性能的代码更改
refactor:既不是修复bug也不是添加特征的代码重构
style:不影响代码含义的修改,比如空格、格式化、缺失的分号等
test:增加确实的测试或者矫正已存在的测试
(2)scope
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
(3)subject
subject是 commit 目的的简短描述,不超过50个字符。
Body
Body 部分是对本次 commit 的详细描述,可以分成多行。有两个注意点。
(1)使用第一人称现在时,比如使用change而不是changed或changes。
(2)应该说明代码变动的动机,以及与以前行为的对比。
Footer
Breaking changes
不兼容修改指的是本次提交修改了不兼容之前版本的API或者环境变量
所有不兼容修改都必须在页脚中作为中断更改块提到,以BREAKING CHANGE:开头,后跟一个空格或者两个换行符,其余的信息就是对此次修改的描述,修改的理由和修改注释
回滚
当此次提交包含回滚(revert)操作,那么页眉以"revert:“开头,同时在正文中添加"This reverts commit hash”,其中hash值表示被回滚前的提交
Reference
https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines
http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
https://zj-git-guide.readthedocs.io/zh_CN/latest/message/Angular%E6%8F%90%E4%BA%A4%E4%BF%A1%E6%81%AF%E8%A7%84%E8%8C%83/
最后
如有不好的地方或做的不对的地方,欢迎联系我
WeChat: Debu_cat
更多推荐
所有评论(0)