Git提交规范指南

这篇具有很好参考价值的文章主要介绍了Git提交规范指南。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

在开发过程中,Git每次提交代码,都需要写Commit message(提交说明),规范的Commit message有很多好处:

  • 方便快速浏览查找,回溯之前的工作内容
  • 可以直接从commit 生成Change log(发布时用于说明版本差异)

为了方便使用,我们避免了过于复杂的规定,格式较为简单且不限制中英文:

<type>(<scope>): <subject>
// 注意冒号 : 后有空格
// 如 feat(miniprogram): 增加了小程序模板消息相关功能

scope选填表示commit的作用范围,如数据层、视图层,也可以是目录名称
subject必填用于对commit进行简短的描述

type必填表示提交类型,值有以下几种:文章来源地址https://www.toymoban.com/news/detail-656221.html

  • feat - 新功能 feature
  • fix - 修复 bug
  • docs - 文档注释
  • style - 代码格式(不影响代码运行的变动)
  • refactor - 重构、优化(既不增加新功能,也不是修复bug)
  • perf - 性能优化
  • test - 增加测试
  • chore - 构建过程或辅助工具的变动
  • revert - 回退
  • build - 打包

到了这里,关于Git提交规范指南的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Git 提交规范

    在项目中采用 git 管理代码版本时,突然不能进行提交(git commit)。 报错信息如下: ERROR invalid commit message format. Proper commit message format is required for automated changelog generation. 合法的提交日志格式如下(emoji 和 模块可选填): 💥 feat(模块): 添加了个很棒的功能 🐛 fix(模块): 修复

    2024年01月19日
    浏览(38)
  • git提交注释规范

    首先下载安装git,配置好公私密钥和github git init git remote add origin [远程库地址] git pull origin master git add . git commit -m “注释” git push origin master 其他: git status git log git branch git checkout git merge type(scope): subject // 空一行 body 用于说明 commit 的类别 br: 此项特别针对bug号,用于向测

    2024年01月24日
    浏览(41)
  • Git代码提交规范

    Git 每次提交代码,都是需要写 Commit message(提交说明),否则就不允许提交。 Commit message 的格式 (三部分): Heaher ----- 必填 type --- 必需 scope --- 可选 subject --- 必需 Body ---- 可省略 Footer ---- 可省略 用于说明 commit  的类别,仅支持允许以下7个标识。 feat:新功能 (feature) fix: 修

    2023年04月09日
    浏览(86)
  • git commit 提交规范

    大致分为三个部分(使用空行分割): 标题行: 描述主要修改类型和内容 主题内容 页脚注释: 放 Breaking Changes 或 Closed Issues type commit 的类型: feat: 新功能、新特性 fix: 修改 bug perf: 更改代码,以提高性能(在不影响代码内部行为的前提下,对程序性能进行优化) refactor: 代码重构

    2024年01月18日
    浏览(55)
  • 【Git】提交规范:格式,类型,范围

    学习一下git提交规范 类型,范围 标题行: 必填, 描述主要修改类型和内容 主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等 页脚注释: 放 Breaking Changes 或 Closed Issues feat: 新功能、新特性(feature) fix: 修补bug perf: 更改代码,以提高性能(在不影响代码内部行

    2024年01月22日
    浏览(36)
  • 前端项目git提交规范配置

    为了使团队多人协作更加的规范,所以需要每次在 git 提交的时候,做一次硬性规范提交,规范 git 的提交信息 安装依赖 配置package.json 新增配置文件 commitlint.config.js 添加自定义提示 .cz-config.cjs 安装 创建 .prettierrc 文件,并添加如下配置, 具体配置可以查看官网 安装(注意:这

    2024年02月19日
    浏览(37)
  • vue项目配置git提交规范

    项目中代码格式以及git message如果不加以约束,可能最终的格式会五花八门,这样很不利于我们的项目合作。所以我们需要使用工具来约束提交代码和信息的格式。 Husky 是一个 Git Hook 工具,可以帮助我们在 Git 事件发生时自动运行脚本。Git Hook 是一种机制,它允许在 Git 执行

    2024年02月11日
    浏览(48)
  • Git 代码提交注释管理规范

    大致分为三个部分(使用空行 分割): 1.  标题行:  必填,  描述主要修改类型和内容 2.  主题内容:  描述为什么修改, 做了什么样的修改,  以及开发的 思 路等等 3 .  页脚注释: 放 Breaking   Changes   或 Closed   Issues 1.1 type commit    的 类型: feat :  新功能、新特性 fix : 修改 b

    2024年04月28日
    浏览(42)
  • Git 的标准提交规范(Conventional Commits)& Git 分支管理

    其中,type 表示本次提交的类型,应该从以下几个类型中选择: feat:新功能 fix:修复问题 docs:文档更新 style:代码风格更新 refactor:重构代码 test:增加测试用例 chore:修改项目配置 [optional scope] 表示本次提交的影响范围,可以根据需要添加。 表示本次提交的描述信息,应

    2024年02月09日
    浏览(58)
  • 统一git使用方法,git状态变迁图,git commit提交规范

    目录 说明 统一git使用方法 git状态变迁图 git commit 提交规范 多次工作中多名员工不懂git多次技术分享,自行查资料学习git并使用,会出现使用各种偏僻的命令,异常问题无法解决;或出现带url的git合并提交;接触git1年一直在请教求助一直未入门。主要是学的不对,培训的不

    2024年02月11日
    浏览(41)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包