↓ 跳过正文
Background Image
  1. Posts/

Git Commit规范

·71 字·1 分钟
Git 技术规范
muzimu
作者
muzimu
目录

基本介绍
#

在使用Git进行代码仓库管理的时候，我们不可避免需要提交Commit，即每次提交代码需要标注本次进行了哪些修改，方便让合作者快速阅览了解开发内容，提高合作效率。目前Angular规范是最广泛的Git Commit规范方法，本文参考下列文档，使用中文编写新手友好的实用教程。 Augular Github规范 参考博客

规范内容
#

Commit信息格式
#

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

其中type(提交类型)和subject(简短描述)是必须项，scope(影响范围)是可选项 第一行为Header(标题)，第二部分为Body(正文)，最后部分为Footer(脚注) 一般实际开发中主要遵循标题规范，即 type(scope): subject，示例如下

feat(第二课堂): 显示第二课堂学分
fix(第二课堂): 修复第二课堂学分显示问题
docs: Readme中增加新人环境配置教程
test: 教务系统API单元测试

Type (提交类型)
#

常用的Type类型如下：

  • feat: 新功能
  • fix: 修复 bug
  • docs: 文档修改
  • style: 不影响代码逻辑的格式调整
  • refactor: 既不是新功能也不是修复 bug 的代码重构
  • perf: 性能优化
  • test: 添加或修改测试代码
  • chore: 构建过程或辅助工具的变动

Scope (影响范围)
#

指定提交影响的模块或文件范围，例如：

  • 第二课堂
  • 教务系统

Subject (简短描述)
#

  • 建议使用中文
  • 简单描述修改内容，使用陈述句，例如"修复了xx问题"
  • 结尾不要使用句号或者其他标点符号

规范Git Commit工具
#

使用VSCode的用户可以安装git-commit-plugin插件，使用效果如下：