git commit 提交规范

git commit 提交规范

前言

每次查看 git log 的时候, 每个提交都五花八门，不利于阅读和维护，因此制定统一标准，促使团队形成一致的代码提交风格，更好的提高工作效率，成为一名有追求的工程师

配置 git

# 设置 user.name
git config --global user.name "your_name"

# 设置 user.email
git config --global user.email "your_email"

# 生成密钥
ssh-keygen -t rsa -C "your_email"

# 查看密钥
cd ~/.ssh

使用 commit message template

设置步骤

# <type>(<scope>): <subject>
# - type: feat, fix, docs, style, refactor, test, chore
# - scope: 用于说明 commit 的范围,可以为空
# - subject: 用于说明 commit 目的的简短描述，不超过50个字符


# feat: 新增feature
# fix: 修复bug
# docs: 仅仅修改了文档，如readme.md
# style: 仅仅是对格式进行修改，如逗号、缩进、空格等。不改变代码逻辑。
# refactor: 代码重构，没有新增功能或修复bug
# perf: 优化相关，如提升性能、用户体验等。
# test: 测试用例，包括单元测试、集成测试。
# chore: 改变构建流程、或者增加依赖库、工具等。
# revert: 版本回滚


# 正文：包含72个字符。 这应该回答：
# - 为什么需要进行此更改？可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等
# - 如何解决这个问题？描述解决问题的步骤
# - 是否存在副作用、影响？


# footer:
# - 包括问题的链接。
# - 突破性变化

将该内容保存为 .gitmessage.txt 文件作为模板，进行以下操作

 # 设置当前分支的提交模板
git config commit.template [模板文件名]

# 设置全局的提交模板
git config  --global commit.template [模板文件名]

在git commit 时候直接运行

git commit

然后按照制定的规范填写相应的信息

范例

# <type>(<scope>): <subject>
# - type: feat, fix, docs, style, refactor, test, chore
# - scope: 用于说明 commit 的范围,可以为空
# - subject: 用于说明 commit 目的的简短描述，不超过50个字符
feat(xxx): 新增用户登录模块


# feat: 新增feature
# fix: 修复bug
# docs: 仅仅修改了文档，如readme.md
# style: 仅仅是对格式进行修改，如逗号、缩进、空格等。不改变代码逻辑。
# refactor: 代码重构，没有新增功能或修复bug
# perf: 优化相关，如提升性能、用户体验等。
# test: 测试用例，包括单元测试、集成测试。
# chore: 改变构建流程、或者增加依赖库、工具等。
# revert: 版本回滚


# 正文：包含72个字符。 这应该回答：
# - 为什么需要进行此更改？可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等
- 增加用户登录接口
# - 是否存在副作用、影响？
没有影响


# footer:
# - 包括问题的链接。
# - 突破性变化