git message规范

在正式参与项目开发之前，了解并且坚持使用一些规范更方便我们与同事之间的合作。这些通常是约定俗成的。

git提交准则

git源码中的Documentation/SubmittingPatches列举了git提交规范相关的说明文档。

提交之前的注意事项

1、检查空白错误
git diff --check #确认将提交的内容中有无空白信息

2、尝试让每一个提交成为一个逻辑上的独立变更集
尽量使每一笔提交都成为独立的patch，这让同事审查你的改动时尽量让事情容易些。

3、重写提交历史
正式提交之前，可以通过修改本地提交历史让提交后的信息更加易懂。

4、规范化提交信息
这里有份Tim Pope 写的模板，看看怎样才是规范的提交描述。稍后我们手动创建一个git message提交模板。

创建git message模板

1、git config
mi@ubuntu:~$ git config --global -e

....
#添加
[commit]
        template = /home/mi/.gitmessage

  

 

  
1
  
2
  
3
  
4
 

2、配置模板
mi@ubuntu:~$ vim ~/.gitmessage

#title [where/what]

#JIRA-ID 

#brief description for this bug [what/why]

#Change-Id:auto-generate

  

 

  
1
  
2
  
3
  
4
  
5
  
6
  
7
 

3、提交使用模板
mi@ubuntu:~$ git commit -s #尽量不用 git commit -m "xx"

4、查看提交记录
mi@ubuntu:~$ git log --no-merges

参考链接

• 分布式Git - 向一个项目贡献
• 编码规范之Git commit message style
• Git commit message 基本规范

文章来源: blog.csdn.net，作者：hinzer，版权归原作者所有，如需转载，请联系作者。

原文链接：blog.csdn.net/feit2417/article/details/105012558