如何写好Git Commit Log

Git每次提交代码时,都必须要写上 git -m “ 提交信息 “ ,否则就不允许提交。很多时候都没有注意过git log的规范,结果写个乱七八糟,根本就想不清楚做了哪些修改。本文是自己参照前辈们习得的一点git message习惯。

一条 commit 应有的信息结构

  • Type 类型

  • Subject 目的

  • Body 内容

Type 类型

  • feat: 增加新功能;

  • fix: 修复错误;

  • docs: 修改文档;

  • style: 修改样式;

  • refactor: 代码重构;

  • test: 增加测试模块,不涉及生产环境的代码;

  • chore: 更新核心模块,包配置文件,不涉及生产环境的代码;

Subject 目的

subject写本次commit的目的是什么,可省略。

Body 内容

body是本次commit的详细描述

  • add 增加

  • mod 修改

  • del 删除

Example

git commit -m "docs: add FAQ in readme file"
// 文档修改:在 readme 文件里添加了 FAQ模块

进阶—–使用Emoji

git commit -m " :emoji1: :emoji2: 主题 "

附:GitEmoji使用规范

最后,祝大家git -message 写的愉快!