Git commit規(guī)范(angular)
原文
https://blog.csdn.net/qq_34035628/article/details/128729400?spm=1001.2014.3001.5502
常用git命令
git?init
git?remote?add?origin?[倉庫地址]
git?add?.
git?commit?–m?“”
git?push?origin?[branch]?
每次進行git提交時,需要寫提交說明,規(guī)范提交說明的好處如下
更加結(jié)構(gòu)化的提交歷史
保證每次信息都有確切的含義
方便直接生成changelog
方便信息搜索和過濾
目前最受開發(fā)人員肯定的規(guī)范是前端框架Angular提出的Angular提交信息規(guī)范
其提交格式如下:
<type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer>
每次提交,Commit message 都包括三個部分:Header,Body 和 Footer。其中,Header 是必需的,Body 和 Footer 可以省略。
Header
(1)type
提交類型指定為下面其中一個:
build:對構(gòu)建系統(tǒng)或者外部依賴項進行了修改
ci:對CI配置文件或腳本進行了修改
docs:對文檔進行了修改
feat:增加新的特征
fix:修復bug
pref:提高性能的代碼更改
refactor:既不是修復bug也不是添加特征的代碼重構(gòu)
style:不影響代碼含義的修改,比如空格、格式化、缺失的分號等
test:增加確實的測試或者矯正已存在的測試
(2)scope
scope用于說明 commit 影響的范圍,比如數(shù)據(jù)層、控制層、視圖層等等,視項目不同而不同。
(3)subject
subject是 commit 目的的簡短描述,不超過50個字符。
Body
Body 部分是對本次 commit 的詳細描述,可以分成多行。有兩個注意點。
(1)使用第一人稱現(xiàn)在時,比如使用change而不是changed或changes。
(2)應該說明代碼變動的動機,以及與以前行為的對比。
Footer
Breaking changes
不兼容修改指的是本次提交修改了不兼容之前版本的API或者環(huán)境變量
所有不兼容修改都必須在頁腳中作為中斷更改塊提到,以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/
最后
如有不好的地方或做的不對的地方,歡迎聯(lián)系我 WeChat: Debu_cat