git 提交规范

简介: git 提交规范

简介

Git 提交规范是一种标准化的方式,用于编写 Git 提交信息,以确保提交历史清晰、易于理解和维护。遵循规范的提交信息可以帮助开发者更好地理解每次代码更改的目的和影响范围,从而提高代码审查、版本回退和信息查找的效率


提交类型(type)

用于说明此次提交的类型,常见的类型包括

  • feat:表示新增了一个新功能
  • modify 修改功能
  • fix:修复了一个bug或问题
  • docs:修改了文档
  • style:修改了代码格式,没有改变逻辑
  • refactor:重构了代码,没有新增功能或修复bug
  • perf:优化了性能
  • test:添加或修改了测试用例
  • chore:构建过程或辅助工具的变动


作用域(scope)

表示此次提交影响的范围,可以是某个模块、组件或功能区域。

主题(subject)

是对此次提交的简短描述,通常以动词开头,使用第一人称现在时态,首字母小写,句尾不加句号。



提交文字规范


格式:提交前缀:动作行为+问题内容


示例:

  • feat:新增xx页面
  • feat:新增xx页面xx功能
  • fix:修复xx页面xx bug
  • modify:修改xx页面xx功能
  • delete:删除xx页面
  • refactor:重构xx页面xx功能
  • style:删除多余注释代码/控制台打印代码
  • refactor:迁移xx文件到xx目录

注意事项

  • 提交的commit发现不符合规范, git commit --amend -m "新的提交信息"或 git reset --hard HEAD^  重新提交一次


目录
相关文章
|
6月前
|
人工智能 缓存 开发工具
结合企业实践来规范你的Git commit(含插件使用指南)
结合企业实践来规范你的Git commit(含插件使用指南)
结合企业实践来规范你的Git commit(含插件使用指南)
|
3月前
|
消息中间件 小程序 Java
【规范】看看人家Git提交描述,那叫一个规矩
本文通过IDEA中的Git描述规范插件【git commit message helper】,介绍了Git提交描述的规范流程,强调了团队开发中统一标准的重要性,并通过实例展示了规范的提交记录如何提高代码管理和维护效率。最后,文章提供了几个实用的Git提交描述案例,帮助读者更好地理解和应用这些规范。
53 0
【规范】看看人家Git提交描述,那叫一个规矩
|
3月前
|
敏捷开发 小程序 持续交付
【规范】Git分支管理,看看我司是咋整的
本文介绍了Git分支管理规范的重要性及其在企业中的应用。通过规范化的分支管理,可加速团队协作、确保代码质量、维护主分支稳定,并支持敏捷开发。文中详细描述了主分支(如master、develop)和辅助分支(如feature、hotfix)的作用,并提供了实际开发流程示例,包括开发前、开发中、提测、预生产和部署上线等阶段的操作方法。旨在帮助团队提高效率和代码质量。
150 0
【规范】Git分支管理,看看我司是咋整的
|
3月前
|
开发工具 git
Git——commit的提交规范
Git——commit的提交规范
99 4
|
3月前
|
JavaScript 测试技术 开发工具
Git 分支设计规范
Git 分支设计规范
185 11
|
3月前
|
存储 测试技术 开发工具
企业Git 规范的必要性-阿里云开发者社区
既然认同需要一份 Git 规范,那么这个规范需要规范哪些内容,解决哪些问题。
|
3月前
|
监控 程序员 开发工具
如何规范Git提交-参考阿里云开发者社区
这篇文章分享了如何规范Git提交,介绍了commit message的格式规范,并通过webhook监控机制来确保代码提交的规范性,从而提高研发效率和代码维护质量。
|
3月前
|
开发工具 git
Git——简单的分支规范
Git——简单的分支规范
39 0
|
4月前
|
前端开发 测试技术 开发工具
|
4月前
|
Ubuntu 开发工具 git
git 超实用教程【人人必会!】(含大厂的 git 操作规范)
git 超实用教程【人人必会!】(含大厂的 git 操作规范)
61 0