Git Commit规范

我们先来看一个简单的commit提交:

git commit -m 'feat: 新增xx功能'

这里阐述了commit message的语法:

<type>(<scoped>): <commit message>

相关参数说明:
type: 本次提交的类型 -> 类型可根据项目团队成员习惯去做相应调整

  • feat: 新功能(feature)
  • fix: 修补bug
  • style: 代码格式(不影响代码运行的变动)
  • docs: 只改动了文档相关的内容(documentation)
  • refactor: 代码重构时使用
  • revert: 执行git revert打印的message
  • build: 构造工具的或者外部依赖的改动,例如webpack,npm
  • perf:性能优化(Performance improvement)
  • test:测试方面的改动
  • ci:与持续集成服务有关的改动
  • chore:不修改src或者test的其余修改,例如构建过程或辅助工具的变动
  • scoped: 可选项,说明影响范围,eg: 数据层/控制层等…
  • commit message: 本次的提交说明, 应清晰明了, 说明本次提交目的.
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Git Commit规范是一种约定俗成的方式,用于规范化提交信息的格式和内容,使得提交历史更加清晰、易读和易于管理。以下是一种常见的Git Commit规范: 1. 提交信息的结构:每个提交信息由三个部分组成:标题、正文和页脚。 标题:简明扼要地描述这次提交的内容,通常以动词开头,使用一般现在时,不超过50个字符。 正文:对提交的详细描述,可以包括为什么进行该提交、做了哪些修改等信息。 页脚:可包含与提交相关的其他附加信息,如关联的Issue编号、作者等。 2. 提交信息的格式:为了保持统一和易读性,可以采用以下格式: ``` <type>(<scope>): <subject> <body> <footer> ``` 其中,`<type>`代表提交的类型,如`feat`(新功能)、`fix`(修复bug)、`docs`(文档更新)等。 `<scope>`代表本次提交的范围,可以是具体的文件、模块或功能名称。 `<subject>`是对本次提交内容的简要描述。 `<body>`是对本次提交内容的详细描述。 `<footer>`是页脚部分,可以包含相关链接、引用等信息。 3. 示例: ``` feat(user): 添加用户注册功能 - 在用户界面增加注册表单 - 后端增加注册接口 Issue #123 ``` 通过遵循Git Commit规范,可以提高团队协作效率、减少沟通成本,并且更好地追踪和管理项目的提交历史。当然,具体的规范可以根据团队的实际需求和偏好进行调整和定制。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值