Git 提交规范

开源 0

一、Git 提交规范的基本格式

通常,Git 提交信息采用以下格式:

<type>: <subject><body><footer>
  1. type(提交类型):用于说明提交的性质,常见的类型有以下几种:
    • feat:新功能(feature)。
    • fix:修复 bug。
    • docs:文档修改。
    • style:代码格式调整(不影响代码逻辑)。
    • refactor:代码重构(不添加新功能也不修复 bug)。
    • perf: 性能优化
    • revert: 回退
    • test:增加测试用例。
    • chore:其他杂项事务,如更新构建工具等。
  2. subject(简短描述):用简洁的语言描述本次提交的主要内容。
  3. body(详细描述):如果需要,可以在 body 部分提供更详细的提交信息,包括背景、解决方法等。
  4. footer(可选):可以用于添加一些关联的问题编号、合并请求编号等信息。

例如:

feat: 添加用户登录功能实现了用户登录的页面和后端逻辑,支持用户名和密码登录。Closes #123

在这里插入图片描述

二、Git 提交辅助插件

Git Commit Message Helper一 个可帮助您标准化提交内容的插件,该插件是源自git-commit-template的加强版,添加一系列个性化的配置。

(一)安装

在 IntelliJ IDEA 中 Settings -> Plugins 搜索 Git Commit Message Helper 安装并重启IDEA
在这里插入图片描述

(二)使用

提交时
在这里插入图片描述

填写提交信息
在这里插入图片描述

也许您对下面的内容还感兴趣: