IDEA：Git 提交规范插件

╰半橙微兮° 2023-10-05 22:04 61阅读 0赞

#### 文章目录 ####

*   *  一、概述
     *  二、安装步骤
     *  三、参数详解

### 一、概述 ###

*  使用`git commit template`可以规范我们在IDEA提交代码是的注释规范
 *  **使用效果如下：首先提交时，点击如下图标：**  
    ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1_size_16_color_FFFFFF_t_70_pic_center][]
 *  **填写提交内容影响类型、影响范围、短注释、长注释等：**  
    ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1_size_16_color_FFFFFF_t_70_pic_center 1][]
 *  **填写完后，自动生成模板：**  
    ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1_size_16_color_FFFFFF_t_70_pic_center 2][]

### 二、安装步骤 ###

*  **打开`settings`下的`plugin`里搜索`git commit template`插件：**  
    ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1_size_16_color_FFFFFF_t_70_pic_center 3][]
 *  安装完后重启IDEA就可以愉快的使用了。

### 三、参数详解 ###

**例子：**

fix(DAO):用户查询缺少username属性 feat(Controller):用户查询接口开发

**type(必须)** 用于说明git [commit][]的类别，只允许使用下面的标识。

feat：新功能（feature）

fix/to：修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。

*  fix：产生diff并自动修复此问题。适合于一次提交直接修复问题
 *  to：只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix。

docs：文档（documentation）

style：格式（不影响代码运行的变动）。

refactor：重构（即不是新增功能，也不是修改bug的代码变动）。

perf：优化相关，比如提升性能、体验。

test：增加测试。

chore：构建过程或辅助工具的变动。

revert：回滚到上一个版本。

merge：代码合并。

sync：同步主线或分支的Bug。

**scope(可选)**  
scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

**subject(必须)**  
subject是commit目的的简短描述，不超过50个字符。

*  建议使用中文。
 *  结尾不加句号或其他标点符号。  
    根据以上规范git commit message将是如下的格式：

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1_size_16_color_FFFFFF_t_70_pic_center]: https://img-blog.csdnimg.cn/20200822141151665.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/20200822141112222.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/20200822141308167.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1_size_16_color_FFFFFF_t_70_pic_center 3]: https://img-blog.csdnimg.cn/20200822141502698.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMDQyOTM1,size_16,color_FFFFFF,t_70#pic_center
[commit]: https://so.csdn.net/so/search?q=commit