一份建议的git commit模板

.git-commit-template.txt

<类型>: <主题> (最多50个字)

# 解释为什么要做这些改动
# |<----  请限制每行最多72个字   ---->|

# --- 提交 结束 ---
# 类型值包含
#    feat (新特性)
#    fix (bug修复)
#    docs (文档改动)
#    style (格式化, 缺失分号等; 不包括生产代码变动)
#    refactor (重构代码)
#    test (添加缺失的测试, 重构测试, 不包括生产代码变动)
#    chore (更新grunt任务等; 不包括生产代码变动)
# --------------------
# 注意
#    主题和内容以一个空行分隔
#    主题限制为最大50个字
#    主题行大写
#    主题行结束不用标点
#    主题行使用祈使名
#    内容每行72个字
#    内容用于解释为什么和是什么,而不是怎么做
#    内容多行时以'-'分隔
# --------------------
# 正例：
# chore: 更新 java 依赖包 xxxxxx
# style: 更改登录页面样式
# fix: 修正登录验证码显示不出的问题
# 反例:
# feat: 增加新功能
# 反例原因：新功能描述不精确。可改成（示例）：feat: 增加登录接口 xxxx
# docs: 更新文档
# 反例原因：docs 本身就是在说文档。可改成（示例）：docs: 对登录接口 xxxx 具体使用时需要注意的特别事项进行说明