Git：注释规范

最新推荐文章于 2024-03-14 11:09:02 发布
最新推荐文章于 2024-03-14 11:09:02 发布
阅读量944 收藏 6
点赞数 1
分类专栏： Git 文章标签： git gitlab
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/MQ0522/article/details/110121307
版权

提交表格

<type>(<scope>): <subject>
// 空一行
<body>

说明

1. type（必需）

用于说明 commit 的类别

  • br: 此项特别针对bug号，用于向测试反馈bug列表的bug修改情况
  • feat：新功能（feature）
  • fix：修补
  • docs：文档（documentation）
  • style： 格式（不影响代码运行的变动）
  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）
  • test：增加测试
  • chore：其他的小改动. 一般为仅仅一两行的改动, 或者连续几次提交的小改动属于这种
  • revert：feat(pencil): add ‘graphiteWidth’ option (撤销之前的commit)
  • upgrade：升级改造
  • bugfix：修补bug
  • optimize：优化
  • perf: Performance的缩写, 提升代码性能
  • test：新增测试用例或是更新现有测试
  • ci:主要目的是修改项目继续完成集成流程(例如Travis，Jenkins，GitLab CI,Circle)的提交
  • build: 主要目的是修改项目构建系统(例如glup，webpack，rollup的配置等)的提交

2. scope（可选）

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

3. subject（必需）

subject是 commit 目的的简短描述，不超过50个字符。
以动词开头，使用第一人称现在时，比如change，而不是changed或changes
第一个字母小写
结尾不加句号（.）

4. body(可选)

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

根号五
关注
  • 1
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
git-2.22.0-2019-06-07更新.rar
06-13
官方发行说明： 过滤器规范“--filter = sparse：path = <path>”用于 创建一个惰性/部分克隆已被删除。使用blob 仍支持稀疏规范的项目的一部分 “--filter = sparse：oid = <blob>”选项。 用户界面，工作流程和功能 *“git checkout --no-overlay”可用于触发新模式 检查出树的路径，允许路径 匹配当前索引和工作树中的pathspec 并且不在树上。 *“git log --format = ...”中的％（预告片）格式化现在允许 可选择按关键字选择预告片，仅显示值， 等等 *四个新的配置变量{author，committer}。{name，email} 已经介绍过更具体地覆盖用户。{name，email} 案例。 *命令行完成（在contrib /中）学会了tab-complete “git submodule absorbgitdirs”子命令。 *“git branch”学习了一个新的子命令“--show-current”。 *“diff --cc”的输出没有显示原始路径 合并涉及重命名。一个新选项添加​​了路径 原始树木输出。 *已经教过命令行完成（在contrib /中） 完成更多子命令参数。 *来自“git bisect”的最终报告用于显示疑似 使用原始“diff-tree”的罪魁祸首，没有输出 合并提交。这已更新为使用更现代和 人类可读的输出仍然很简洁。 *“git rebase --rebase-merges”取代旧的“--preserve-merges” 选项; 后者现在标记为已弃用。 *使用--recurse-submodules进行克隆时给出的错误消息 已更新。 *完成帮助程序代码现在关注存储库本地 配置（如果可用），允许--list-cmds兑现 例如，completion.commands的特定于存储库的设置。 *“git mergetool”学会了提供Sublime Merge（smerge）作为其中之一 它的后端。 *当磁盘索引时调用新的钩子“post-index-change” 文件更改，可以帮助例如虚拟化工作树 实现。 *“git difftool”现在可以在存储库外运行。 *“git checkout -m <other>”是关于携带差异的 检查时HEAD和工作树文件之间的转发 另一个分支，忽略了HEAD与之间的差异 指数。该命令已经被教导在索引和中止时中止 HEAD是不同的。 *“index-pack”步骤中添加了一个进度指示器 经常让用户在“git clone”期间等待完成。 *“git submodule”学习允许的“set-branch”子命令 子模块。*。要修改的分支设置。 *“git merge-recursive”后端最近学到了一种新的启发式方法 根据同一目录中其他文件的方式推断文件移动 移动。因为这本身就不那么强大的启发式算法 基于文件本身的内容相似性（而不是 根据其邻居正在做的事情，它有时会给出一个 最终用户意外的结果。这已经降低了 将重命名的路径保留在索引中较高/冲突的阶段中 用户可以检查并确认结果。 *“git tag”学会了建议它可能是一个建议 创建指向的带注释或签名的标记时出错 另一个标签。 *学习“git pack-objects”命令报告数量 它通过trace2机制打包的对象。 *结束时编辑器中显示的冲突路径列表 当剪刀线在剪刀线上方显示出冲突的合并 清理模式设置为“剪刀”，即使它被评论 就像更新的路径列表和其他信息一样 帮助用户更好地解释合并。 * trace2跟踪工具学会了自动生成文件名 当被告知登录目录时。 *“git clone”在交谈时学会了一个新的--server-option选项 协议版本2。 *默认情况下，裸连接位图是创建的 现在存储库; 还创建了路径名哈希缓存 默认为避免在重新包装时产生蹩脚的增量。 *“git branch new A ... B”和“git checkout -b new A ... B” 教导说，在他们的语境中，符号A ... B表示“合并 这两个提交之间的基础“，就像”git checkout A ... B“ 在该提交中分离HEAD。 *更新“git difftool”和“git mergetool”以便组合 {diff，merge}。{tool，guitool}配置变量用作 以合理的顺序相互后备设置。 *“git difftool”的“--dir-diff”模式在“--no-index”中没用 模式; 它们现在被明确标记为互不兼容。
git提交代码注释规范
01-12
git提交代码注释规范、git提交常用操作的规范指南、[A] 新增 ：(新加入的需求) [M] 修改 ：( 修改或者重构代码) [D] 删除 ：(删除多余的文件 ) [F] 修复 ：(修复bug)
Git 代码提交注释管理规范
最新发布
探索IT世界
03-14 1140
大致分为三个部分(使用空行分割): 1. 标题行: 必填, 描述主要修改类型和内容 2. 主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等 3. 页脚注释: 放 BreakingChanges或 ClosedIssues
git commit 注释规范
zhangx
07-26 1070
说明： 1.用一空行分隔标题与正文。 2.标题使用大写字母。 3.标题不超过50个字符。 4.标题使用祈使语气。 5.标题不要使用句号结尾。 6.正文在72个字符处换行。 7.正文解释是什么和为什么，而不是如何做。 关键字： Add 新增 Mod 修改 Del 删除 Fixed 修复 例子： 新增开放平台验证接口，Token支援多种调用方式，修复短信...
Git提交注释规范
记录工作的常用技术、技能技巧
09-23 460
Git提交注释规范
gitlab-ci详细说明
demon7552003的小本本
05-22 4209
文章目录概念PipelineStagesJobsjob分组variables自定义变量预定义变量使用变量关键词全局关键词before_scriptafter_scriptincludeStage关键词Job关键词scriptimageartifactstagscachestagewhenonly/exceptdependenciesextendstriggerrulesallow_failurecoveragepagesreleaseresource_groupretrytimeout参考gitlabci变
如何规范Git提交注释
信天翁的博客
09-05 2142
如何规范Git提交注释Git提交注释的构成Git提交注释的7个好规则Separate subject from body with a blank line / 使用空行分割主题与内容Limit the subject line to 50 characters / 主题行限制为50个字符Capitalize the subject line / 主题行首字母大写Do not end the subject line with a period/ 主题行行尾不添加句号Use the imperative
Git 提交注释的常见规则和最佳实践
ChinaLiaoTian的博客
07-05 2607
Git 提交注释的最佳实践
git提交注释规范
忘川
01-23 898
ci:主要目的是修改项目继续完成集成流程(例如Travis，Jenkins，GitLab CI,Circle)的提交。build: 主要目的是修改项目构建系统(例如glup，webpack，rollup的配置等)的提交。scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。chore：其他的小改动. 一般为仅仅一两行的改动, 或者连续几次提交的小改动属于这种。refactor：重构（即不是新增功能，也不是修改bug的代码变动）用于说明 commit 的类别。
Git 注释规范
Cash Blog
06-05 9596
提交格式： <type>(<scope>): <subject> // 空一行 <body> 范例: fix #251: add DataValidation 提交的具体情况 说明： type（必需） 用于说明 commit 的类别 br: 此项特别针对bug号，用于向测试反馈bug列表的bug修改情况 feat：新功能（fe...
Git提交代码注释信息规范-相关命令汇总
天道酬勤
07-19 9245
Git提交代码注释信息规范-相关命令汇总
gitlab 服务器端代码格式以及git提交信息格式检查钩子文件，可以拿来直接使用
09-15
gitlab 服务器端代码格式以及git提交信息格式检查钩子文件，可以拿来直接使用，匹配的阿里p3c代码规范检查插件，已经打包好，可以直接下载：https://download.csdn.net/download/TangKai_java/86539113
伪造的：ActivityPub的扩展，用于基于Web的Git服务联合
02-23
合作至少某些Git Web服务实现必须同意这样的规范。 如果您是此类软件的开发人员，请并发表意见。 我们将简单地将您添加到工作组中。 如果您有编写规范的经验，也欢迎您加入。邮件列表我们仍在等待所有临时工作组成员...
阿里巴巴IDaaS前端开发规范1
08-03
1.1【强制】不允许 template 中有解析错误 1.1.1 注释标签不能为空「abrupt-closing-of-empty-comment」 1.1.3
gitlab-ci.yaml 带注释说明
JineD的博客
09-22 6653
# Task 默认在docker里面运行, 运行完成后就删掉, 里面的东西不会保存. # Task 默认运行使用的docker镜像, 如果Task里面没有指定的话默认使用这个. image: git.com:9999/docker-image/golang # 环境变量 (会自动注入到 Task 运行的 shell 环境中) variables: CI_REPOSITORY_NAME: git.com/${CI_PROJECT_PATH} CI_DOCKER_ROOTDIR: "b.
Git命令总结，建议收藏（作为一名四有程序员咱最终还是要走命令行的路子）
Ningdz的博客
09-26 565
目前团队内部看到不少小伙伴都在用Git的图形化工具，例如GitHub for Desktop、Source Tree、TortoiseGit（小乌龟）等等。我个人其实并不排斥用这些图形化工具，我也是从这些图形化工具上走过来的，但这就是一个过渡，作为一名有理想的程序猿咱最后还是要走命令行的路子。况且没觉得敲命令行的小哥哥或者小姐姐更nice么？不说笑了，其实在咱们的开发过程中很多时候真的命令行比工具更可靠，有的疑难杂症真的需要命令行才能解决。图形化工具就是一个封装了的组件，可塑性不如原生的命令行来的实在。下.
规范Git提交备注，从现在开始
Tony666688888的博客
11-28 477
【代码】规范Git提交备注，从现在开始。
【Git】Git commit 注释规范
南方有乔木的博客
05-21 981
【Git】Git commit 注释规范 1 前言 规范的注释方便自己进行合并、撤消、回退。当代码有几十个分支，有成千上万条提交时，你随时可能面临着合并分支，回退代码，舍弃代码，对比代码，复制历史记录中有用的代码片段等等。如果仅靠千篇一律的注释，是很难从快速从注释中提取有用的信息，并且会遇到选择困难，不知道要合并哪个点，不知道要回退到哪里等。而传统的tag是用来记录大版本号，或发布时使用的。 2 注释格式 [标签]：[注释内容] 标签的作用是快速识别和判断出当前提交的内容的...
vscode git注释
05-01
在进行Git提交时，我们需要遵守一些常规的注释信息规范，比如要简洁明了地描述我们所做的更改，同时避免使用中文和特殊字符等影响代码历史记录查看的缺陷。总之，VSCode为Git提交提供了非常便捷的注释功能，我们只...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

根号五

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值