git commit 写法

commit 写法

一般来说,git commit 的信息包括三个部分:type、scope 和 subject

type 前缀

type 是用来表示你的代码变更的类型,它可以帮助你和其他开发者更清晰地了解你的代码的目的和影响,常用的前缀如下:

  • feat: 表示你添加了一个新的功能或特性。
  • fix: 表示你修复了一个 bug 或错误。
  • docs: 表示你修改了文档或注释。
  • style: 表示你修改了代码的格式或风格,不影响代码的逻辑或功能。
  • test: 表示你添加或修改了测试用例或代码。
  • chore: 表示你修改了构建过程或辅助工具,不影响代码的运行。
  • revert: 表示你撤销了之前的一个 commit。
  • perf: 表示你优化了代码的性能或效率
  • improvement: 表示你改进了一个已有的功能或特性。
  • refactor: 表示你重构了代码,即在不改变功能的前提下优化代码的结构或质量。

scope 范围

scope 是用来表示你的代码变更的范围,常用的范围表示如下:

method:表示你修改了某个方法或函数的代码
class:表示你修改了某个类或对象的代码
module:表示你修改了某个模块或组件的代码
file:表示你修改了某个文件的代码,
directory:表示你修改了某个目录下的代码
project:表示你修改了整个项目的代码

subject 描述

subject 是用来描述你的代码变更的目的,它应该以动词开头,使用第一人称现在时,不超过50个字符,结尾不加句号

示例:

refactor (method): optimize performance by adding const and &