怎样写好git comment

Git提交的comment是为了别人能够快速了解代码提交的目的，下面给出了实践中总结的写好git comment的方式。

基本格式

• 简单：只有标题， git commit –m “<类型>: <主题>”
• 详细：标题+内容，git commit 会车，然后编辑输入：

  <类型>: <主题>
  // 空一行
  <内容>
  

  内容一般缩进4个字符

常用类型

• Feature：新特性
• BugFix：bug修复
• Optimize：优化和改善，用户可见的提升，不会影响基本逻辑和功能，比如性能提升，界面美化
• Refactor：重构，功能完全等价，实现方式上的变更，比如把重复代码提取到公共类，把超大的函数拆分成几个意义明确的小函数等等

怎样写好内容

• BugFix
  标题写：问题现象，比如：

  Cannot manage xxx server
  

  Exception while manage xxx server
  

  内容：可以写的比较多，一般写：
  Why：问题根因是什么
  What：解决方案是什么
  如果有什么遗留问题，有什么待改进的也可以写在这
• Feature
  标题写：需求描述，比如：

  Support xxx for yyy
  

  Support xxx management
  

  内容：一般不用写，也可以详细写一下需求内容，比如具体有哪些子功能，特性支持哪些字段