admin 管理员组

文章数量: 1087139


2024年3月19日发(作者:openstack目的)

Git提交规范及使用说明

一.Git提交规范

一次提交包含四个信息:

commit message - 提交的内容相关描述

author & committer - 作者及提交者

changed files - 修改的文件

hash & parent - 提交内容的hash及在提交树上的位置

1.提交信息

一般包括

三部分。

是必须的,一般在50个字符之内,其结构为:(其中

可以不写)

():

│ │ │

│ │ └─⫸ Summary in present tense. Not

capitalized. No period at the end.

│ │

│ └─⫸ Commit Scope:

animations|bazel|benchpress|common|compiler|

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

表明本次提交的类型,一般有如下几种:

build: 涉及构建相关的改动

ci: 持续集成相关的改动

docs: 文档

feat: 新功能

fix: bug修复

perf: 性能相关改动

refactor: 重构相关(非bug、非新功能)

test: 测试相关,包括新增测试或者更改已有测试

使用现在时或祈使句。

提交信息的更为详细的描述,与

一样也是用祈使句、

现在时。描述本次 修改的动机,比如为什么引入本次改动,

之前的逻辑是什么,现在的逻辑是什么,本次改动有哪些影响,等等。

最后,

是可选项,一般涉及破坏性改动、功能的弃用等说明,

以及对GitHub issue或Jira ticket的引用,PR的引用等。


本文标签: 提交 改动 相关 测试 作者