Home
img of docs

学习如何在Git提交中遵循格式规范,包括常用的提交信息格式和关键字,提升代码审查的效率。

chou403

/ Git

/ c:

/ u:

/ 3 min read

一学一个不吱声

Conventional Commits 规范,这种规范帮助开发团队更好地组织和理解 Git 提交历史,尤其在自动化工具如版本发布、生成变更日志等场景中非常有用。

提交信息格式

通常,提交信息遵循如下格式:

   <type>(<scope>): <message>
  • type:提交的类型,例如 feat(新特性)、fix(修复)、chore(杂项任务)、docs(文档)等。
  • scope:可选的范围,表示影响的模块或文件。
  • message:简短的描述性信息,说明此次提交的目的或内容。

feat 的含义

feat 表示“feature”,用于描述对项目功能的新增或改进。例如:

   feat(user-auth): add login feature with JWT token

这个提交信息的意思是“在用户认证模块中,添加了基于 JWT 的登录功能”。

为什么使用 feat

  1. 清晰的提交历史:使用规范化的提交信息使代码历史更加易读,开发者可以快速理解每次提交的内容。
  2. 自动化工具支持:如 semantic-release 等工具可以自动根据提交信息生成版本号和变更日志。
  3. 团队协作:团队成员可以清楚地知道每个提交的目的,特别是在大型项目中,有助于代码审查和协作。

其他常见的提交类型

  • fix:修复 bug。
  • chore:杂项任务,如配置文件修改、构建脚本更新等。
  • docs:文档修改。
  • style:代码格式调整,不影响代码逻辑。
  • refactor:代码重构,既不修复 bug 也不添加功能。
  • perf:性能优化。
  • test:添加或修改测试。
  • build:构建过程相关的修改。
  • ci:持续集成相关的修改。

实际使用示例

  1. 添加新特性: 
       feat(api): implement user registration endpoint
  2. 修复问题: 
       fix(auth): correct token expiration bug

通过遵循这样的提交信息约定,项目的开发和维护会变得更加高效和可预测。

#git