Git提交规范

614 阅读1分钟

一、提交信息格式

每个 Git 提交信息都应该包含一个清晰简洁的标题和一个更详细的描述。提交信息格式如下:

<type>(<scope>): <subject>
空行
<body>
空行
<footer>

  • type:提交类型
    • feat:新功能
    • fix:修复bug
    • docs:文档变更
    • style:代码格式(不影响代码运行的变动,如格式化)
    • refactor:代码重构(既不是新功能也不是修bug)
    • test:增加或修改测试
    • chore:构建过程或辅助工具的变动
  • scope(可选):影响范围
    • 指此次改动的影响范围,比如文件名、模块等
  • subject:简短描述
  • body:详细描述
  • footer:一些元数据,比如关联的 issue、PR 等

二、示例

feat(system):新增系统管理

包含用户管理、角色管理、菜单管理

Closes #123

  • Closes:是一个关键字,表示这个提交解决了某个Issue
  • #42:是Issue的编号。这个编号指向项目中的一个具体问题或任务

三、提交粒度

1. 原子性提交

每次提交应该完成一个独立的功能或修复,避免一次提交中包含多个不相关的更改。这样可以让代码历史更加清晰,方便定位问题。

2. 频繁提交

尽量保持提交的频率,不要等到完成所有工作才提交。频繁提交有助于保存工作进度,便于回滚到特定状态。