当前位置: 首页 > news >正文

Git Commit 规范

良好的,遵循一定规则的提交信息不仅有助于编码历史的回顾。

格式 Format

每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。其中,Header 是必需的,Body 和 Footer 可以省略。

<type>(<scope>): <subject>

Header 部分只有一行,包括三个字段:type(必需)、scope(可选)和 subject(必需)。

主题 Subject

subject 是本次 commit 目的的简短描述,一般不要超过50个字符:

  • 使用祈使句和现在时:例如使用 “change” 而不是 “changed” 或 “changes”。
  • 规范大小写和相应书写规则。
  • 无需加句号符标识结尾。
类型 Type

类型是描述当前提交性质的枚举类型,含有以下的枚举值:

build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
docs: 文档相关
feat: 特性增加
fix: 异常修复
perf: 性能优化
refactor: 代码重构
style: 不影响代码含义的改动 (white-space, formatting, missing semi-colons, etc)
test: 对测试的增加或修复
merge: 用于 merge branch 时,需要手写 commit message 的情况
revert: 用于撤销之前的 commit

在这里插入图片描述

参考:
https://www.conventionalcommits.org/en/v1.0.0/#summary
https://github.com/o-w-o/way/blob/master/appendixs/wiki/git-commit.md
https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
https://developer.jdcloud.com/article/1511


http://www.mrgr.cn/news/48768.html

相关文章:

  • 对偶范数(Dual Norm)
  • Java-学生管理系统[初阶]
  • uniapp-小程序开发0-1笔记大全
  • sklearn pipeline
  • 中科星图GVE(案例)——AI实现建筑用地变化前后对比情况
  • node.js服务器基础
  • C++笔记---红黑树的插入删除
  • 数据结构-5.2.树的性质
  • 【C语言教程】【常用类库】(四)数学函数库 - <math.h>
  • 浅谈钓鱼攻防之道-制作免杀word文件钓鱼
  • 幽默视频下载网站推荐
  • C#拓展方法
  • 一文搞懂什么是 classpath
  • 备受好评的 5 款安卓手机数据恢复工具推荐
  • vim实用笔记
  • Windows 下 cocos2d-x-3.17.2 VS2017开发环境搭建
  • 机器学习与神经网络:从技术前沿到诺贝尔奖的跨越与未来展望
  • Python酷库之旅-第三方库Pandas(145)
  • 【Adobe全家桶】 Adobe 全家桶 AE AU PR ME WIN MAC 各个版本
  • 安卓无障碍获取录屏权限