Skip to content

Instantly share code, notes, and snippets.

@viko16
Last active June 27, 2016 09:41
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save viko16/4f5131f1624e03b95180e3b59b372d2f to your computer and use it in GitHub Desktop.
Save viko16/4f5131f1624e03b95180e3b59b372d2f to your computer and use it in GitHub Desktop.
Commit message 的格式

Header

Header 部分只有一行,包括三个字段:

type(必需)、scope(可选)和subject(必需)。

type

用于说明 commit 的类别,只允许使用下面7个标识。

  • feat:新功能
  • fix:修复问题
  • docs:更新文档
  • style:格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动,理论上不影响现有功能)
  • perf: 提升性能的改动
  • test:增加修改测试用例
  • chore:构建过程或辅助工具的变动
  • deps: 升级依赖

scope

scope用于说明 commit 影响的范围

比如数据层、控制层、视图层等等,视项目不同而不同。

subject

subject是 commit 目的的简短描述,不超过50个字符。

  • 以动词开头,使用第一人称现在时,比如change,而不是changedchanges
  • 第一个字母小写
  • 结尾不加句号(.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment