Git提交代码备注规范

本文主要阐述在git commit时备注信息的提交规范

feat/update: 添加修改代码功能
fix:修复bug
chore: 非功能性修改,.gitignore/辅助工具等变更
style:非功能性修改,主要体现在变更代码风格或格式化代码等
test: 添加/修改现有的测试
perf: 改进性能的变更
refactor: 代码重构变更
docs: 文档相关变更
revert:回退
build:打包
  • 4
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
做好代码管理是一个好的习惯,良好的git提交代码规范可以让你的团队更好地管理代码。下面是一些有用的建议: 1.提交消息应该清晰,准确,描述改变发生的原因,不仅是改变的内容。使用短的摘要(50个字符以内)来描述改变,然后跟上更详细的说明(不超过72个字符)。这些说明应该解释为什么这个改变被做出来,解释这个改变如何影响代码。 2.在分支上工作并提交(并合并)后,需要在提交信息中给出添加或从分支中移除的功能文件或功能,以及说明下你对其如何工作的看法。 3.在撰写提交信息时,避免使用语气过度积极的字眼,这并没有太大的意义。也不要让写作变得如此无聊,以至于没有人想读或理解什么你所说的。 4.提交流程应该清楚明了。需要保持一致和合理性。在一般情况下,对应的一个功能内容的所有变化将组成一个完整的提交。 5.提交信息的编写时间和更新时间应该与提交代码的时候相同。如果需要,说明何时开始编写提交信息,何时被更新等信息。 6.最后,不要忘记提交所有相关文件。如何选择是“提交所有”或是只定部分代码自动提交,要看使用的 git 服务软件、项目的复杂度等多种因素; 有时候你可能需要提交来自整个项目的所有更改,有时候则只需提交单个文件或更改的一小部分。根据你的工作流程,采取最佳做法即可。 以上是一些关于git提交代码规范的有用建议,如果能在团队内建立好的规范,将会更加简化和加速开发流程。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值