git commitコミット仕様

1434 ワード

その他の記事
(): 



大致分为三个部分(使用空行分割):

  1. 标题行: 必填, 描述主要修改类型和内容
  2. 主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等
  3. 页脚注释: 放 Breaking Changes 或 Closed Issues

type: commit 的类型

  • feat: 新特性
  • fix: 修改问题
  • refactor: 代码重构
  • docs: 文档修改
  • style: 代码格式修改, 注意不是 css 修改
  • test: 测试用例修改
  • chore: 其他修改, 比如构建流程, 依赖管理.
  • scope: commit 影响的范围, 比如: route, component, utils, build...
  • subject: commit 的概述

body: commit 具体修改内容, 可以分为多行.

footer: 一些备注, 通常是 BREAKING CHANGE 或修复的 bug 的链接.

示例

fix(修复BUG)

如果修复的这个BUG只影响当前修改的文件,可不加范围。如果影响的范围比较大,要加上范围描述。

例如这次 BUG 修复影响到全局,可以加个 global。如果影响的是某个目录或某个功能,可以加上该目录的路径,或者对应的功能名称。

//   1
fix(global):  checkbox       
//   2         common         
fix(common):        BUG,                     14px
//   3
fix: value.length -> values.length

Feat(新機能または新ページの追加)
feat:           

      ,              。
 
     ,    BUG            。

chore(その他の変更)
choreの中国語翻訳は日常事務、定例作業であり、その名の通り、他のcommitタイプでの修正はなく、choreで表すことができる.
chore:              

他のタイプのcommitと上記の3つの例はあまり差がなく、ここでは述べない.