前言

git commit template 该插件是为了规范git提交注释的。一个项目一个团队的git log一定要整整齐齐的。
统一的提交注释规范，除了自己赏心悦目获得极大的舒适感以外，还能为后续的code review、版本升级change log文档的生成，提供极大的便利。 

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

  • 含义：

    提交类型(改动涉及范围): 简要描述
    <空行>
    详细描述(可换多行进行描述)
    <空行>
    <页脚>（BREAKING CHANGE重大改动描述；Close Issue）

  • 提交类型：

    • feat：新功能开发
    • fix：bug修复
    • docs：项目文档改动
    • style： 代码格式（不影响代码运行的变动,空格,格式化,等等）
    • refactor：重构（理论上不影响功能的代码重构）
    • perf: 性能优化
    • test：增加或者修改测试
    • build: 影响构建系统或外部依赖项的更改(maven)
    • ci: 对CI配置文件和脚本的更改
    • chore：对非 src 和 test 目录的修改
    • revert: 还原上一次提交

  • 以feat提交为例，commit message格式如下:

    feat(系统管理): 新增用户密码设置规则检验  

    (1)验证密码设置由大小写字母数字特殊符号任意三种组合
    (2)验证密码设置长度8-12位

  • 注：

    • 提交格式中type 、subject为必填，scope、body 、footer为选填
    • revert提交时以revert:开头, 后面跟着被撤销Commit的Header。
      Body部分的格式是固定的，必须写成This reverts commit ,
      其中的hash是被撤销 commit 的 SHA 标识符.

Git Commit Template插件的安装与使用

  • 安装

idea中直接File->Setting->Plugins搜索安装即可

  • 使用

  1. 安装并重启idea后，操作提交时会有此按钮

  2. 点击弹出

  3. 按需填写并确认后生成以下格式：

利用conventional-changelog生成Change log

  • 安装
    npm install -g conventional-changelog-cli
  • 生成
    conventional-changelog -p angular -i CHANGELOG.md -s
  • 生成的md效果如下

更多可参考:

Git 提交的正确姿势：Commit message 编写指南
IDEA 中 Git Commit message 编写
Commit message 和 Change log 编写指南

本文作者：Lee
本文地址： leeblog.icu/2020/09/13/
版权声明：本博客所有文章除特别声明外，均采用 CC 4.0 BY-NC-SA 许可协议。转载请注明出处！