代码提交日志规则CommitRule

当我们添加代码要提交到git仓库中时,我们需要统一下规范,这样不会显得整个项目乱糟糟的,当然是需要花点时间来学习和改变的。每次提交的代码尽量短小,涉及范围不要太广,专注于某个领域。

每次提交,Commit message 都包括两个部分:header和body。

<type>(<scope>): <subject>
<BLANK LINE>
<body>

其中,header 是必需的,body 可以省略。 不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。这是为了避免自动换行影响美观。

Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。

type

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

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • build : 改变了build工具 如 xbuild改成了xmake
  • revert : 撤销上一次的 commit
  • chore : 构建过程或辅助工具的变动,比如把grub改成了UEFI。

如果type为featfix,则该 commit 将肯定出现在 Change log 之中。其他情况(docschorestylerefactortest)由你决定,要不要放入 Change log,建议是不要。

scope

scope用于说明 commit 影响的范围,比如文件系统,进程管理,内存管理等等,视项目不同而不同。

例如在mm,thread,fs等。

如果你的修改影响了不止一个scope,你可以使用*代替。

subject

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

其他注意事项:

  • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
  • 第一个字母小写
  • 结尾不加句号(.)

Body

Body 部分是对本次 commit 的详细描述,可以分成多行。下面是一个范例。

Add fatfs, suport fat12, fat16, fat32, exfat.

- fat12: used for floppy
- fat32: used for sdcard/harddisk

有两个注意点:

  • 使用第一人称现在时,比如使用change而不是changed或changes。
  • 永远别忘了第2行是空行
  • 应该说明代码变动的动机,以及与以前行为的对比。

举例

feat(mm): add buddy system

Add simple buddy system code, it works weel.
fix(mm): bug on buddy alloc page
docs(mm): add buddy system doc
style(*): add NX_ prefix for all kernel function
refactor(mm): update buddy system
test(mm): add utest for buddy system
revert: feat(mm): add buddy system

results matching ""

    No results matching ""