Git代码提交规范

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

Git 代码规范

Git 每次提交代码,都是需要写 Commit message(提交说明),否则就不允许提交。

Commit message 的格式 (三部分):

  • Heaher ----- 必填

    • type ---必需

    • scope --- 可选

    • subject --- 必需

  • Body ---- 可省略

  • Footer ---- 可省略

Type说明

用于说明 commit  的类别,仅支持允许以下7个标识。

  • feat:新功能 (feature)

  • fix: 修补bug

  • docs:文档(documentation)

  • style:格式(不影响代码运行的变动)

  • refactor:重构 (既不是新增功能,也不是修改bug的代码变动)

  • test:增加测试

  • chore:构建过程和辅助工具的变动注释

如果type为featfix,则该 commit 将肯定出现在 Change log 之中。其他情况(docschorestylerefactortest)由你决定,要不要放入 Change log,建议是不要。

图片

效果如下:

图片

Scope

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

例如在Angular,可以是$location, $browser, $compile, $rootScope, ngHref, ngClick, ngView等。

如果你的修改影响了不止一个scope,你可以使用*代替。

subject

subject是 commit 目的的简短描述,不超过50个字符。

其他注意事项:

  • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes

  • 第一个字母小写

  • 结尾不加句号(.)

Body

Body 部分是对本次 commit 的详细描述,可以分成多行。

有两个注意点:

  • 使用第一人称现在时,比如使用change而不是changed或changes。

  • 永远别忘了第2行是空行

  • 应该说明代码变动的动机,以及与以前行为的对比。

Footer

Footer 部分只用于以下两种情况:

  • 不兼容变动

    • 如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法

  • 关闭 Issue

    • 如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。

Closes #234

  

Revert

还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header。

revert: feat(pencil): add 'xxxxx' option` `This reverts commit docsxxx.

Body部分的格式是固定的,必须写成This reverts commit <hash>.,

其中的hash是被撤销 commit 的 SHA 标识符。

  • 如果当前 commit 与被撤销的 commit,在同一个发布(release)里面,

那么它们都不会出现在 Change log 里面。

  • 如果两者在不同的发布,那么当前 commit,会出现在 Change log 的Reverts小标题下面。文章来源地址https://www.toymoban.com/news/detail-408415.html

总结

  • feat: 项目名-xxx功能或需求变动的修改
  • fix: 项目名-XXX问题bug的修复
  • refactor: 项目名-xxx代码重构
  • style: 项目名-xxx代码格式整理
  • config: 项目名-xxx配置文件修改
  • docs: 项目名-xxx文档修改
  • revert: 项目名-XX代码回滚
  • test: 项目名-XXX测试类

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

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

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

相关文章

  • 【git每次更新或者提交代码时都需要输入用户名和密码问题解决】

    输入一下命令:git config --global credential.helper store 再次更新代码操作时,依然会提示让你输入用户名和密码,再次输入一遍,系统会记录下你的用户名和密码,后面就不再需要输入了。 在C:/用户/你的账户/.gitconfig文件打开就可以看到用户名和密码被记录进去了。

    2024年02月12日
    浏览(47)
  • git 提交vue代码时遇 代码检查 规范性 报错 导致提交不了

    git 提交vue代码时遇 代码检查 规范性 报错 导致提交不了, ​ 在代码提交之前,进行代码规则检查能够确保进入git库的代码都是符合代码规则的。但是整个项目上运行lint速度会很慢,lint-staged能够让lint只检测暂存区的文件,所以速度很快。 一般是eslint检查导致,在package.j

    2024年02月11日
    浏览(40)
  • 如何规范使用Git及提交代码的要求

    Git是目前最流行的版本控制系统之一,它可以帮助开发人员更好地管理代码版本,并协作开发。使用Git进行代码管理需要遵循一些规范和技巧,本文将介绍如何规范地使用Git,常用的Git命令和技巧,以及如何创建分支和提交代码。 规范地使用Git可以帮助团队更好地协作开发,

    2024年02月15日
    浏览(44)
  • Git应用——代码提交规范 feat ,fix ,style

    feat 增加新功能 fix 修复问题/BUG style 代码风格相关无影响运行结果的 perf 优化/性能提升 refactor 重构 revert 撤销修改 test 测试相关 docs 文档/注释 chore 依赖更新/脚手架配置修改等 workflow 工作流改进 ci 持续集成 types 类型定义文件更改 wip 开发中 feat :提交新功能 fix :修复了b

    2024年02月04日
    浏览(40)
  • Git永久或者限时保存用户名及密码,解决每次拉取或者提交代码时都需要手动输入验证信息

    介绍 这里以我自身项目情况为例: 依据项目要求,这边使用了 TortoiseGit 进行项目的统一管理,下载了 TortoiseGit 克隆项目之后,每次拉取或者提交代码,都会弹出一个提示框,要求输入用户名及密码。 解决方式 单个仓库内设置,只作用于对当前仓库 在当前项目目录文件夹下

    2024年02月03日
    浏览(51)
  • 解决git提交每次都要输入密码

    当我们使用git提交代码的时候使用的是HTTPS的方式,每次提交都会重新输入用户名密码 在我们的项目目录下打开控制台 输入 git config --global credential.helper store 然后你会在c盘用户下生成一个.git-credentials,上边记录你的账号和密码,只需要输入一次用户名和密码,就会把账户信

    2024年02月11日
    浏览(50)
  • 解决git每次提交都需要输入用户密码

    在github上贴上了服务器ssh的公钥后,在服务器上推送代码仍旧提示需要输入git的账号和密码。 这是因为此时的仓库是http协议下载的,此时的链接并不是通过ssh的,因此在推送代码时,会提示输入git的账号和密码。 可以通过 git remote -v 命令查看 修改为SSH连接的方法如下: 1、

    2024年02月11日
    浏览(63)
  • 【git笔记】每次提交都要输入账号密码

    解决 :这是因为使用了https连接到仓库的原因,只需把原本使用HTTPS的方式改为使用SSH的方式即可。 学习把本地项目托管到Gitee 参考下面网址 https://blog.csdn.net/qq_46450354/article/details/127600066#h5o-13 安装以上网址进行操作,用的就是HTTPS连接方式。 【具体把 使用HTTPS的方式改为使

    2024年02月06日
    浏览(56)
  • 解决每次提交代码都需要输入账号和密码的问题

    第一步:进入项目目录,在 git 终端执行以下命令: 第二步:重新执行一次git pull,这次它还是提示你输入账号和密码: 后面再 pull 或者 push 的时候,就不用输入账户和密码了。 注意,如果你换了git账号,或者你换了电脑,执行完 \\\"git config --global credential.helper store\\\" 再 \\\"git

    2024年02月15日
    浏览(55)
  • Git 提交描述规范

    在Git提交消息中,可以使用特定字符来表示特定的功能,这些字符的使用可以提高提交描述的可读性和易用性,常见的字符如下: fix :表示该提交用于修复错误或问题。 feat :表示该提交用于添加新功能。 docs :表示该提交用于更新文档。 style :表示该提交用于代码格式化

    2024年02月16日
    浏览(43)

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

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

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

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

二维码1

领取红包

二维码2

领红包