多人協作開發一個項目時,版本控制工具是少不了的,git是linux 內核開發時引入的一個優秀代碼管理工具,利用它能很好使團隊協作完成一個項目。為了規范團隊的代碼提交,也方便出版本時的release note,更為了出問題時方便代碼回溯,所以大家統一用一個模板提交代碼是必要的。Git中設置template非常簡單,只需以下幾步即可:
1、在根目錄建立模板文件
如 xxx_template文件,其內容如下:
Function Or Bug:
Symptom:
Root Cause:
Solution:
Project:
Note:
- feat: 新功能
- fix: 修復bug
- docs: 只有文檔改變
- style: 並沒有影響代碼的意義(空格,去掉分號,格式的修改等)
- refactor: 代碼的修改並沒有修改bug,也沒有添加新功能
- perf: 代碼的修改提高的性能
- test: 添加測試
- chore: 構建過程或構建工具的改變(並沒有生產環境代碼的改變)
2、設置模板,命令如下
git config commit.template [模板文件名] //這個命令只能設置當前分支的提交模板
git config — —global commit.template [模板文件名] //這個命令能設置全局的提交模板,注意global前面是兩杠
例如: git config commit.template xxx_template
git config --global commit.template xxx_template
3、設置文本編輯器,命令如下:
git config --global core.editor [編輯器名字]
例如:git config --global core.editor vi
4、編輯模板提交代碼,命令如下
git commit
注意:a、git commit之前先要使用 git add 將沒有入庫的代碼入庫
b、可以使用 git commit -a 提交多個代碼文件
5、在第四步之后,會以設置的編輯器打開模板文件,然后按照格式修改該文件,並保存
6、提交代碼到遠程分支
git push