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

git命令的规范

最近在实习当中意识到了自己在git命令命名的不规范,现在已经是团队合作了,一定要规范自己的git提交,所以mentor发了这一篇文档让我学习
https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
简单地进行了总结

git命令的规范

格式化的 Commit message 有三大好处:

  1. 提供更多历史信息,方便快速浏览:可通过 git log <last tag> HEAD --pretty=format:%s 查看每次提交的目的。
  2. 过滤特定提交:例如,用 git log <last release> HEAD --grep feature 只显示新功能。
  3. 自动生成 Change log:基于提交记录直接生成版本变更文档。

1、Commit message 的格式(Angular 规范)

每次提交包括三部分:Header、Body、Footer。

格式示例:

<type>(<scope>): <subject><body><footer>
  • Header 必需,Body 和 Footer 可省略。
  • 任何一行不超过 72 字符(或 100 字符),避免自动换行影响美观。

Header 字段说明

  • type(必需):说明提交类别,仅允许以下 7 种:
    • feat:新功能
    • fix:修补 bug
    • docs:文档
    • style:格式(不影响代码运行)
    • refactor:重构(非新增功能或 bug 修复)
    • test:增加测试
    • chore:构建过程或辅助工具变动注:featfix 必然出现在 Change log 中,其他类型可选。
  • scope(可选):说明影响范围(如数据层、视图层)。
  • subject(必需):简短描述(≤50 字符),要求:
    • 动词开头,第一人称现在时(如 changechanged)。
    • 首字母小写,结尾不加句号。

2. Body 部分

  • 详细描述提交内容,可分多行。
  • 使用第一人称现在时,说明代码变动的动机及与之前行为的对比。

3. Footer 部分

仅用于两种情况:

  • 不兼容变动:以 BREAKING CHANGE 开头,描述变动、理由及迁移方法。
  • 关闭 Issue:格式如 Closes #234Closes #123, #245

4. 特殊情况:Revert

撤销提交时,Header 以 revert: 开头,Body 固定格式:

This reverts commit <hash>(hash 为被撤销提交的 SHA 标识符)。

http://www.dtcms.com/a/561495.html

相关文章:

  • 人形机器辅助设备
  • 深圳找网站建设公司沈阳男科医院哪家好哪个医院正规
  • 目标检测算法与原理(二):Tensorflow实现迁移学习
  • 用 Flink CDC 将 MySQL 实时同步到 Doris
  • win7家用电脑做网站服务器网站开发实习报告
  • 鲸鱼算法详细原理,公式,应用案例-鲸鱼算法优化扩展卡尔曼滤波EKF
  • 「PPG信号处理——(4)基于PPG-ECG 多模态生理信号预处理与特征提取方法研究」2025年11月2日
  • 【Kotlin内联函数】
  • (论文速读)YOLA:学习照明不变特征的低光目标检测
  • 太原网站建设方案开发开源之家
  • 系统思考修炼之旅
  • 网站 默认首页网站域名ip地址查询
  • 矩阵系统哪个好?2025年全方位选型指南与品牌深度解析
  • 合肥瑶海区网站建设方案陇南网站建设
  • 怎么做vip视频网站dedecms 网站还原
  • 网站关键词标签php 网站源代码
  • 本地仓库如何同时绑定多个远程仓库
  • 网站基础建设巴巴商友圈wordpress最好用php
  • Maven 详解(上)
  • 25年05月架构甄选范文“论AI软件测试”,软考高级,系统架构设计师论文
  • Maven 详解(下)
  • 网站建设和托管商业网站建设与维护
  • 国内优秀的企业网站seo排名优化服务
  • 网站开发毕设文档上海软件外包公司名单
  • 4.2 IPv4【2009统考真题】
  • Photoshop - Photoshop 工具栏(21)吸管工具
  • 网站建设专公众号平台有哪些
  • wordpress 全站过滤河南省建设厅官网查询
  • AEB对碰撞安全的作用
  • [论文阅读] AI + 教育 | AI赋能“三个课堂”的破局之道——具身认知与技术路径深度解读