Git 作为一款多人分布式版本管理控制工具,目前在软件开发领域做软件源代码版本控制用最多,主要的功能使用过的人都明白。这篇博客将介绍如何在 git 提交代码的时候能做一个规范的 commit 消息,这对于一个大型多人的项目至关重要,提交信息要简洁明了也要能充分描述本次修改的内容,变更的代码行数和文件所在地址,不过目前很多 git 仓库已经集成完整的不错交互功能,例如 GitHub 有完善的代码提交评审界面来协助仓库管理员管理其他人员的代码修改提交记录。


Commit 消息体

git 针对的 commit 的操作是把暂存区的代码提交到本地的仓库中,每次修改代码片段之后如何编写一条完整的 commit 消息,如编写呢?这里有我推荐一条例子:

<type>: <subject>

<body>

<footer>

如果是一个顶级开源项目应该还包括了文档,其中 <type> 是必需的,表示提交的类型,常用的类型有:

  • feat 是 feature 意思,针对是项目添加新的功能和特性。
  • fix 是修复什么 bug ,针对是项目的问题。
  • docs 如果你项目有文档或者代码注释更新。
  • style 代码格式这个针对一些没有标准的代码格式化功能的语言用,目前新编程语言已经有代码自动化工具。
  • refactor 重构了项目代码,此时应该用这个开头。
  • test 为项目代码添加了单元测试代码。
  • chore 自动化构建辅助工具的变动。

上面都是针对的标题开头,能让其他人一眼看出可能做出变动的修改,下面是紧跟 : 后面的主题内容:

  • <subject> 是必需的,一段简单的描述项目做修改。
  • <body> 主题消息部分是可选的,是对提交的详细描述,可以分为多行编写,每行可以有字数限制和 72 个字符。
  • <footer> 是可选的,包含一些元数据,如相关的 issue 编号、关联的 pull request 等。

下面是一个完整的提交信息例子:

feat: add login feature.

Add a new login page and API endpoint to allow users to log in to the system.

Fixes #8888

这个提交表示新增了一个登录功能,并提到了修复的 issue 编号。


其他资料

便宜 VPS vultr
最后修改:2023 年 07 月 05 日
如果觉得我的文章对你有用,请随意赞赏 🌹 谢谢 !