后期優(yōu)化了一版更加清晰, 可以直接參考 git commit 提交規(guī)范(優(yōu)化)
不規(guī)范?
Git每次提交代碼，都要寫(xiě) Commit message（提交說(shuō)明），否則就不允許提交。但是，一般來(lái)說(shuō)，commit message 應(yīng)該清晰明了，說(shuō)明本次提交的目的。當(dāng)出現(xiàn)問(wèn)題或者查看提交記錄的時(shí)候也能快速的定位到該次提交, 不正當(dāng)?shù)奶峤?讓人一頭霧水,??再??
- 1.測(cè)試提交?
- .中英混合?
- .no no no 是什么?
??.jpg
??.jpg
再看下前端框架Angular.js 采用的規(guī)范提交記錄
591642591847_.pic_hd.jpg
會(huì)不會(huì)清晰很多??, (好像英文看起來(lái)沒(méi)中文的簡(jiǎn)潔??, 當(dāng)然這只是語(yǔ)言問(wèn)題, 我們自己開(kāi)發(fā)項(xiàng)目提交記錄還是用中文)
配置
規(guī)范帶來(lái)的好處就不再多說(shuō), 直接上干貨, 文章末尾會(huì)附上腳本, 可根據(jù)自身需求更改模板
1.下載腳本到本地
下載腳本, 或者創(chuàng)建一個(gè)文件復(fù)制文末腳本到文件, 修改文件名后綴以.sh結(jié)尾即可, 下載或者創(chuàng)建目錄沒(méi)有限制, 任意位置即可
圖片.png
2. 到需要配置git 提交規(guī)范的項(xiàng)目根目錄
圖片.png
3. 執(zhí)行腳本
直接把腳本拖入終端,回車執(zhí)行即可, 因?yàn)槭堑谝淮螆?zhí)行腳本,可能沒(méi)有權(quán)限,會(huì)報(bào)錯(cuò)
圖片.png
直接輸入密碼進(jìn)行授權(quán)即可
sudo chmod u+x 腳本
圖片.png
授權(quán)完成, 執(zhí)行腳本
圖片.png
這里會(huì)再次讓輸入密碼確認(rèn)
圖片.png
最后執(zhí)行成功, 提交規(guī)范配置成功??????
4.重啟Sourcetree 提交改動(dòng)
先看下不規(guī)范的提交
圖片.png
直接提交失敗, 可根據(jù)彈窗中提示進(jìn)行修改提交信息
圖片.png
圖片.png
修改/ 刪除 git提交規(guī)范
如果配置模板或者規(guī)范不滿足自身需求, 可自行修改
如果不想繼續(xù)使用規(guī)范,可以進(jìn)行卸載, 在腳本后面增加參數(shù) uninstall 即可卸載
圖片.png
#!/bin/bash
## 到項(xiàng)目跟目錄執(zhí)行該腳本
ST_COMMIT_MSG=".stCommitMsg"
COMMIT_MSG="commit-msg"
GIT_HOOKS=".git/hooks"
GIT_COMMIT_MSG="$GIT_HOOKS/$COMMIT_MSG"
FIRST_DO="0"
installGitRules() {
whiteFile() {
cat >>$ST_COMMIT_MSG <<EOF
<type>(<scope>) : <subject>
<body>
<footer>
EOF
}
pushd ~/
if [ ! -f $ST_COMMIT_MSG ]; then
echo "$ST_COMMIT_MSG file not exist"
touch .stCommitMsg
whiteFile
else
COPY_FILE="${ST_COMMIT_MSG}_backup"
cp -P ~/$ST_COMMIT_MSG ~/$COPY_FILE
: >$ST_COMMIT_MSG
whiteFile
fi
popd
writeCommitMsg() {
cat >>.git/hooks/commit-msg <<EOF
#!/bin/bash
TIP_MESSAGE='
<type>(<scope>) : <subject>\n
<body>\n
<footer>\n
\n
#type 本次修改功能類型\n
.feat :新功能\n
.fix :修復(fù)bug\n
.opt :優(yōu)化(optimize) 圖片壓縮, 文件刪除等\n
.ci : 版本號(hào)升級(jí)、branchConfig修改、scrip/podinfo.rb等發(fā)布相關(guān)修改\n
.test :增加測(cè)試\n
.refactor :某個(gè)已有功能重構(gòu)\n
.docs :文檔改變\n
.style :代碼格式改變\n
.revert :撤銷上一次的 commit (revert 命令自動(dòng)生成)\n
\n
#scope :用來(lái)說(shuō)明此次修改的影響范圍\n
.all :表示影響面大 ，如修改了網(wǎng)絡(luò)框架 會(huì)對(duì)真?zhèn)€程序產(chǎn)生影響\n
.loation :表示影響小，某個(gè)小小的功能\n
.module :表示會(huì)影響某個(gè)模塊 如登錄模塊、首頁(yè)模塊 、用戶管理模塊等等\n
\n
#subject: 用來(lái)簡(jiǎn)要信息描述本次改動(dòng)\n
\n
#body :具體的修改信息 應(yīng)該盡量詳細(xì)\n
\n
#footer :備注: 文檔鏈接、bug id、設(shè)計(jì)文檔\n
'
MSG=\$(awk '{printf("%s",\$0)}' \$1)
if [[ \$MSG =~ ^(feat|fix|opt|ci|test|refactor|docs|style|revert)\(.*\):.*$ ]]; then
echo -e " commit success!"
else
echo -e \MSG
echo -e " Error: the commit message is irregular "
echo -e " Error: type must be one of feat|fix|opt|ci|test|refactor|docs|style|revert"
echo -e ' eg: feat(租房): 詳情頁(yè)增加無(wú)盡流'
echo '詳細(xì)文檔??????'
echo -e \$TIP_MESSAGE
exit 1
fi
EOF
}
if [ ! -d $GIT_HOOKS ]; then
pushd .git
mkdir hooks
mkfile -n 0b hooks/commit-msg
popd
writeCommitMsg
else
if [ ! -f $GIT_COMMIT_MSG ]; then
mkfile -n 0b $GIT_COMMIT_MSG
writeCommitMsg
else
COPY_FILE="${COMMIT_MSG}_backup"
cp -P $GIT_COMMIT_MSG $GIT_HOOKS/$COPY_FILE
: >$GIT_COMMIT_MSG
writeCommitMsg
fi
fi
sudo chmod 777 $GIT_COMMIT_MSG
if [ $FIRST_DO != '0' ]; then
echo 'Configuration is successful! ?????? '
echo 'Restart Sourcetree then submit your changes!'
fi
}
uninstallGitRules() {
if [ ! -f $GIT_COMMIT_MSG ]; then
echo "Don't have git commit message rules to remove!"
else
rm $GIT_COMMIT_MSG
echo "remove git commit message rules success!"
fi
pushd ~/
if [ ! -f $ST_COMMIT_MSG ]; then
echo "$ST_COMMIT_MSG file not exist, Don't have git commit rules template to remove!"
else
rm $ST_COMMIT_MSG
echo "remove git commit message rules template success!"
fi
popd
}
install() {
installGitRules
FIRST_DO="1"
installGitRules
}
if [ $# == 0 ]; then
install
exit
fi
for i in "$*"; do
if [ $i == "install" ]; then
install
elif [ $i == "uninstall" ]; then
uninstallGitRules
else
install
fi
done
