Git 提交信息书写规范

小陆_39194983

已于 2024-06-29 14:48:15 修改

阅读量857

点赞数 34

分类专栏： # commit 文章标签： git

于 2024-06-29 14:37:22 首次发布

本文链接：https://blog.csdn.net/qq_39194983/article/details/140062570

版权

commit 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

commit message 书写规范

规范的必要性
提交规则
使用方式
Vscode 插件

规范的必要性

日常开发中，版本管理至关重要，清晰明了的提交信息方便自己快速了解每一个版本修改内容。
假设有一个项目，只有你自己一个人开发，那么你怎么写都是无所谓的，但是如果是多人协作，特别是团队表较大的时候，那么规范的提交信息就很重要了。良好的提交信息，便于后期方便排查与回退，过滤关键字便于迅速定位

提交规则

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

type：【必填】用于说明 commit 类别，可以是以下几种：
- feat：新功能
- fix：修复bug
- docs：文档变更
- style：代码风格变更（不影响代码运行的变动，如去掉空格、改变缩进、增删分号）
- refactor：重构（既不是新增功能，也不是修复bug的代码变动）
- perf：性能优化
- test：增加或修改测试代码
- chore：构建过程中或辅助工具的变动
- build：改变构建流程，新增依赖库、工具、构造工具的或者外部依赖的改动，例如webpack，npm
- ci：自动化流程配置修改、与 CI（持续集成服务）有关的改动
- revert：回滚版本
scope：【选填】用于说明 commit 影响范围，一般是修改的什么模块或者是什么功能
subject：【必填】用简明的语言描述 commit 的目的，不要结束句点，因为Git会自动添加
body:：【选填】详细描述，对于功能详细的描述，可以使用多个段落进行详细说明，解释为什么做这个改动、使用了什么方式，有什么注意事项等等
footer：【选填】添加一些额外的信息，包括2个字段: Breaking Changes（中断性不兼容变动）、Closed Issues（关闭issue问题），如果改动关闭了某个issue，可以在这里指出issue的编号，如：Closes # 123

body 填写要求：
1、要以动词开头，使用第一人称现在时，比如change
2、第一个字母小写
3、结尾不加句号（.）

示例：feat(用户模块)：新增用户登录模块
本次提交增加了用户登录页面，保证使用系统的人员是可控的
Closes #123

使用方式

为了规范的执行更好的落实，我们借助一款 Node 插件 validate-commit-msg 来检查项目中 Commit message 是否规范。

1、安装插件

npm install --save-dev validate-commit-msg

2、添加package.json文件配置

"config": {
    "validate-commit-msg": {
      "types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "chore", "build", "ci", "revert"],
      "warnOnly": false,
      "extends": []
    }
  }

3、自定义校验格式【可选】：创建 .vcmrc 文件

{
  "types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "chore", "build", "ci", "revert"],
  "scope": {
    "required": false,
    "allowed": ["*"],
    "validate": false,
    "multiple": false
  },
  "warnOnFail": false,
  "maxSubjectLength": 100,
  "subjectPattern": ".+",
  "subjectPatternErrorMsg": "subject does not match subject pattern!",
  "helpMessage": "",
  "autoFix": false
}