Git 注释规范

最新推荐文章于 2024-05-08 16:31:00 发布
最新推荐文章于 2024-05-08 16:31:00 发布
阅读量9.6k 收藏 27
点赞数 4
分类专栏： 工具
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_37726449/article/details/90901611
版权

提交格式：

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

范例:

fix #251: add DataValidation

提交的具体情况

 说明：

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的配置等)的提交

scope（可选）

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

subject（必需）

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

<body>(可选)

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

 

优化自：https://www.jianshu.com/p/79454cf00945

Git Commit message 编写指南: https://gitee.com/help/articles/4231#article-header0

cashZhang27
关注
  • 4
    点赞
  • 踩
  • 27
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
git提交代码注释规范
01-12
git提交代码注释规范、git提交常用操作的规范指南、[A] 新增 ：(新加入的需求) [M] 修改 ：( 修改或者重构代码) [D] 删除 ：(删除多余的文件 ) [F] 修复 ：(修复bug)
Git Commit 规范1
08-03
Git Commit 规范是软件开发过程中非常重要的一个环节，它有助于保持代码库的整洁和历史记录的可读性。在Git中，一个良好的Commit消息能够清晰地表达每次提交的目的和内容，使得团队成员能快速理解代码变更，这对于...
Git 提交注释的常见规则和最佳实践
ChinaLiaoTian的博客
07-05 2736
Git 提交注释的最佳实践
git 常用命令大全（附命令注释）
sysole的博客
06-06 3160
【代码】git 常用命令大全（附命令注释）
git 常用命令及注释
最新发布
weixin_54097396的博客
05-08 709
git clone 克隆代码git log 查看日志git tag 查看标签git branch 查看分支git branch -a 查看远程分支git pull 拉取。
GIT注释规范推荐
大白菜
06-22 759
GIT释规范推荐 为什么需要规范 无规矩不成方圆，编程也一样。 如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。 这时候，有人提出了何不统一标准，大家都按照这个标准来。于是 ESLint，JSHint 等代码工具如雨后春笋般涌现，成为了项目构建的必备良品。 Git Commit 规范可能并没有那么夸张，但如果你在版本回退的时候看到一大段糟心的 Commit，恐怕
Git：注释规范
MQ0522的博客
11-25 959
提交格式 <type>(<scope>): <subject> // 空一行 <body> 说明 type（必需） 用于说明 commit 的类别 br: 此项特别针对bug号，用于向测试反馈bug列表的bug修改情况 feat：新功能（feature） fix：修补 docs：文档（documentation） style： 格式（不影响代码运行的变动） refactor：重构（即不是新增功能，也不是修改bug的代码变动） ..
Git提交规范结合实践
04-11
Git提交规范是软件开发团队协作中的重要组成部分，它有助于保持代码历史清晰，便于代码审查，回溯更改，以及自动化发布流程。以下是对标题和描述中所述知识点的详细说明： 1. **提交过程规范**： - **初始提交**：...
Git使用规范及部分代码规范.pdf
12-31
Git使用规范及代码规范 Git使用规范 提交说明是 Git 使用中非常重要的一部分，它可以帮助开发者快速了解 Commit 的目的和影响范围。提交说明通常由三部分组成：类型、范围和简要说明。 1. 类型（Type）：用于...
Git分支操作及团队协作规范1
08-08
Git 分支管理和团队协作规范是高效软件开发的关键组成部分。Git 是一种分布式版本控制系统，它允许开发者在多个分支上同时工作，有效地支持了敏捷开发和持续集成。以下是对标题和描述中提到的知识点的详细说明： 1....
git命令汇总以及命令注释
07-28
囊括绝大部分git操作命令以及命令注释
开发中git提交代码注释规范
sunnyday0426的博客
05-18 2577
提交代码时，应在注释中清晰描述变更内容，包括变更目的、实现方式、可能影响范围等信息，以便于团队成员理解和审查。
git 常用命令大全（附命令注释）_git命令大全，大数据开发外包是如何转正华为的
2301_78399616的博客
04-15 1612
在分支上的工作做到一半时 如果有切换分支的需求, 我们应该将现有的工作存储起来。checkout 对工作目录是安全的 reset --hard是强制覆盖。**一个时刻只会指向一个分支)，当我们有新的提交的时候，分支上所有的内容处于已修改状态，或第二次以后的已暂存状态。(避免)分支上的内容是初始化创建 第一次处于已暂存状态。(避免)分支上的内容是初始化创建 处于未跟踪状态。在切换的时候 一定要保证当前分支是干净的!本质指向一个分支，分支的本质是一个提交对象。reset --hard 时是带着分支走。
git提交注释规范
weixin_45727786的博客
03-23 7579
1.chore：项目初始化 git commit -m 'chore: 新建项目' 2.feat：增加新功能 git commit -m 'feat: xx' 3.fix:修改bug的提交 git commit -m 'fix: xxx' 4.style:样式修改、布局修改 git commit -m 'style: xxx' 5.test:部署测试环境 git commit -m 'test: xxx' 也可以换行写注释 例: git commit -m 'fix: xxx xxx xxx'
git 修改注释
taget的专栏
12-06 1万+
当你不小心，写错了提交的注视/信息，该如何处理呢。理论上，SCM是不应该修改历史的信息的，提交的注释也是。    不过在git中，其commit提供了一个--amend参数，可以修改最后一次提交的信息.但是如果你已经push过了，那么其历史最后一次，永远也不能修改了。    我使用git commit --amend已经push过的，截图如下，我那个"fixes #3"永远的在版本历史中了。
git commit 提交注释规范
热门推荐
傲雪星枫
11-28 2万+
本文将介绍使用git commit时的注释规范，提高commit内容的可读性及理解。
如何修改git注释信息(强迫症患者的福音)
大葱的田地
03-25 2231
最新的一次提交 当你不小心写错了提交的注释信息，该如何处理呢？理论上，SCM是不应该修改历史的信息的，包括提交的注释。 不过在git中，其commit提供了一个--amend参数，可以修改最后一次提交的信息。但是如果你已经push过了，那么其历史最后一次，永远也不能修改了。 使用git commit --amend，在出来的编辑界面直接编辑注释的信息，保存退出。 历史提交 gi...
vscode git注释
05-01
VSCode是一款功能强大的代码编辑器，而Git是一款流行的版本控制工具。当我们在使用Git进行协作开发时，我们经常需要在提交代码时添加注释来描述我们所做的更改。VSCode为Git提交提供了很多便利的功能，比如我们可以在代码中右键点击选择“Git:提交”来提交我们的更改，也可以通过键盘快捷键Ctrl + Shift + G打开Git面板进行操作。 在进行Git提交时，我们需要写清楚我们所做的更改，这样方便其他开发人员查看我们的代码历史记录。VSCode提供了一个便捷的界面来让我们轻松地添加注释。当我们选择“Git:提交”后，会弹出一个提交消息框，我们可以在里面输入相关的注释信息。VSCode也提供了一些快捷键来让我们更加快速地完成注释的填写，比如按Ctrl + Enter快速提交，并且使用Tab键来自动补全注释信息。 在进行Git提交时，我们需要遵守一些常规的注释信息规范，比如要简洁明了地描述我们所做的更改，同时避免使用中文和特殊字符等影响代码历史记录查看的缺陷。总之，VSCode为Git提交提供了非常便捷的注释功能，我们只需要简单地在提交消息框中书写我们的注释信息即可完成提交。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值