Skip to content

Git 提交规范

格式

消息必须由以下格式构成:

<type>(<scope>): <subject>
  │       │          │
  │       │          └─⫸ Commit Subject: 描述变化,结尾没有句号
  │       │
  │       └─⫸ Commit Scope: core|theme

  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

Type

  • build: 构建工具或外部依赖包的更改。

  • ci: 持续集成的配置文件或脚本的更改。

  • docs: 仅包含文档的更改。

  • feat: 新增特性。

  • fix: 修复 Bug 。

  • perf: 提高性能的代码更改。

  • refactor: 既不修复错误也不添加功能的代码更改(重构)。

  • test: 添加或更改测试代码。

Scope

  • core: Electron 核心代码的更改。

  • theme: 页面代码的更改。

Subject

使用摘要字段对更改进行简洁描述,结尾没有句号(。)。

举例

  • 对 package.json 的修改
ci: 更换应用图标
  • 增加页面
feat(theme): 增加首页页面
  • 修复 Bug
fix(theme): 计时器无法停止

开发文档