git提交信息规范化

当我们编写完代码 ,提交到远程仓库的时候,一般会用到git提交。

commit之前需要写commit message,

对应的类型有:

build:影响构建系统或者外部依赖关系的更改

ci:更改我们的持续集成文件和脚本

docs:仅文档更改

feat:一个新功能

fix:修复错误

perf:改进性能的代码更改

refactor:代码更改,既不修复错误也不添加功能

style:不影响代码含义的变化(空白,格式化,缺少分号等)

test:添加缺失测试或更正现有测试

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Git 提交规范是指在提交代码时,按照一定的规范来书写提交信息。这些规范包括提交信息的格式、提交信息的内容等方面。采用 Git 提交规范可以提高代码的可读性和可维护性,方便项目的管理和协作开发。 下面是一个常用的 Git 提交规范引入指南: ## 为什么需要 Git 提交规范? 在协作开发项目的过程中,经常会遇到多人同时修改同一个文件的情况。如果每个人提交的代码都采用不同的格式和风格,那么在后期维护和合并代码时就会变得非常困难。因此,为了方便团队协作开发,需要对提交信息进行规范化。 ## Git 提交规范的格式 Git 提交规范的格式通常由三部分组成:标题、空行和正文。 ### 标题 标题是提交信息的第一行,通常不超过 50 个字符。它应该简明扼要地描述本次提交所做的修改。 例如: - 添加了用户注册功能 - 修复了登录页面的样式问题 - 更新了项目文档 ### 空行 标题和正文之间需要空一行,以便于阅读。 ### 正文 正文是提交信息的详细描述,通常包括以下三个部分: 1. 修改的原因: 描述为什么需要做这个修改,它的背景和目的是什么。 2. 修改的内容: 描述具体做了哪些修改,包括新增、修改、删除等操作。 3. 具体实现方式: 如果有必要,可以简要地描述修改的具体实现方式。 例如: ``` 添加了用户注册功能 为了让用户能够注册账号,我们添加了新的注册页面和注册接口。同时,我们还更新了首页和登录页面,让用户能够更方便地进行注册和登录操作。 - 添加了注册页面和注册接口 - 更新了首页和登录页面 - 注册页面采用了表单验证和验证码验证的方式 ``` ## Git 提交规范的内容 在提交代码时,需要遵循一定的提交规范。下面是一些常用的提交规范: 1. feat:新功能 例如:添加了用户注册功能 2. fix:修复问题 例如:修复了登录页面的样式问题 3. docs:文档修改 例如:更新了项目文档 4. style:代码格式修改 例如:调整了代码缩进和空格 5. refactor:代码重构 例如:重构了用户注册功能的代码 6. test:测试代码修改 例如:增加了用户注册功能的单元测试 7. chore:其他修改(如构建过程或辅助工具的变动) 例如:更新了依赖库的版本号 ## 总结 通过 Git 提交规范,可以提高代码的可读性和可维护性,方便项目的管理和协作开发。在实际开发中,需要遵循一定的提交规范,并且在提交信息中尽量详细地描述本次提交所做的修改。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值