Datawhale学习笔记:faster git丨202401 task04
第七章 Git提交规范
Git 中的每一次提交(commit)都包含了丰富的信息,这些信息对于代码的版本控制和协作开发都非常重要。一次commit包括以下信息:
-
Commit Message(提交信息):
-
Author & Committer(作者及提交者):
-
Changed Files(修改的文件):
-
Hash & Parent(提交内容的 Hash 及在提交树上的位置):
7.1 Commit Message
- 这是关于此次提交内容的简短描述,用于快速了解此次变更的目的或解决了什么问题。
- 一个好的提交信息应该清晰、简洁,并能提供足够的信息来理解变更的内容和原因。
Commit Message描述的是当前提交内容的相关信息,一般包括header
,body
,footer
。
7.1.1 Angular格式
Angular建议格式如下:
<type>(<scope>): <short summary>
│ │ │
│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end.
│ │
│ └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core...
│
└─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
-
Commit Type(提交类型):这是提交信息的第一个部分,用来说明提交的性质。常见的类型包括:
build
: 涉及构建相关的改动feat
: 新功能(feature)fix
: 修补bugdocs
: 文档更新style
: 代码风格(不影响代码逻辑的变动,如空格、格式化、分号等)refactor
: 重构(即不是新增功能,也不是修改bug的代码变动)perf
: 性能优化test
: 增加测试chore
: 构建过程或辅助工具的变动ci
: 持续集成配置文件的改动