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

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.kler.cn/a/349840.html

相关文章:

  • [权限提升] 常见提权的环境介绍
  • STM32标准库移植RT-Thread nano
  • 性能优化2-删除无效引用
  • HTML特殊符号的使用示例
  • 【leetcode】T1599
  • 从单体应用到微服务的迁移过程
  • DBdoctor推出无Agent轻量级纳管解决方案
  • 低代码策略量化平台更新|大模型agents生态的一些思考
  • STM32F407 定时器实例解析
  • 录屏工具TOP10,探索你最爱的免费屏幕录制软件!
  • 华为OD机试真题-最佳种树距离-2024年OD统一考试(E卷)
  • Spring Boot:中小型医院网站的性能优化
  • 谈谈我的理解:引用计数 vs 可达性分析
  • 静态路由、动态路由以及默认路由
  • 【计算机网络篇】数据链路层 协议、介质访问控制
  • 毕业32年,重回32中
  • 期刊论文投稿指南:如何利用ChatGPT精准选择合适的期刊?
  • Spring MVC实现高效文件上传及优化案例
  • 阿里巴巴1688上的图片批量保存下载的方法
  • Java面试宝典-并发编程学习01
  • 【数据结构与算法】力扣 42. 接雨水
  • mysql 10 单表访问方法
  • 物联网视频监控系统
  • 数据恢复与取证: 使用 OSForensics 从未启动 Android 设备中获取数据
  • [Gtk] layout.ui
  • php+mysql测试环境