git提交信息书写规范

type:【必填】用于说明 commit 类别,可以是以下几种:

  • feat:新功能
  • fix:修复bug
  • docs:文档变更
  • style:代码风格变更(不影响代码运行的变动,如去掉空格、改变缩进、增删分号)
  • refactor:重构(既不是新增功能,也不是修复bug的代码变动)
  • perf:性能优化
  • test:增加或修改测试代码
  • chore:构建过程中或辅助工具的变动
  • build:改变构建流程,新增依赖库、工具、构造工具的或者外部依赖的改动,例如webpack,npm
  • ci:自动化流程配置修改、与 CI(持续集成服务)有关的改动
  • revert:回滚版本

scope:【选填】用于说明 commit 影响范围,一般是修改的什么模块或者是什么功能

subject:【必填】用简明的语言描述 commit 的目的,不要结束句点,因为Git会自动添加

body::【选填】详细描述,对于功能详细的描述,可以使用多个段落进行详细说明,解释为什么做这个改动、使用了什么方式,有什么注意事项等等

footer:【选填】添加一些额外的信息,包括2个字段: Breaking Changes(中断性不兼容变动)、Closed Issues(关闭issue问题),如果改动关闭了某个issue,可以在这里指出issue的编号,如:Closes # 123

示例:feat(用户模块):新增用户登录模块 
本次提交增加了用户登录页面,保证使用系统的人员是可控的 Closes #123

body 填写要求:
1、要以动词开头,使用第一人称现在时,比如change
2、第一个字母小写
3、结尾不加句号(.)

posted @ 2025-07-02 18:45  柠凉w  阅读(43)  评论(0)    收藏  举报