• 博客园logo
  • 会员
  • 众包
  • 新闻
  • 博问
  • 闪存
  • 赞助商
  • HarmonyOS
  • Chat2DB
    • 搜索
      所有博客
    • 搜索
      当前博客
  • 写随笔 我的博客 短消息 简洁模式
    用户头像
    我的博客 我的园子 账号设置 会员中心 简洁模式 ... 退出登录
    注册 登录
敬YES
Now Or Never
博客园    首页       联系   管理    订阅  订阅
开发软技能——Git Commit规范
开发软技能——Git Commit规范 今天敬姐给大家分享一个好的编程习惯,就是关于Git Commit规范

提交代码是程序员们每天的工作日常,今天敬姐给大家分享一个好的编程习惯,就是关于Git Commit规范。

效果预览

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

提交之后的效果如下:

img

Git Commit 语法

  1. type: 必填 commit 类型,有业内常用的字段,也可以根据需要自己定义
  • feat 增加新功能
  • fix 修复问题/BUG
  • style 代码风格相关无影响运行结果的
  • perf 优化/性能提升
  • refactor 重构
  • revert 撤销修改
  • test 测试相关
  • docs 文档/注释
  • chore 依赖更新/脚手架配置修改等
  • workflow 工作流改进
  • ci 持续集成
  • types 类型定义文件更改
  • wip 开发中
  • undef 不确定的分类
  1. scope: commit 影响的范围, 比如某某组件、某某页面
  2. subject: 必填 简短的概述提交的代码,建议符合 50/72 formatting
  3. body: commit 具体修改内容, 可以分为多行, 建议符合 50/72 formatting
  4. footer: 其他备注, 包括 breaking changes 和 issues 两部分

IDEA插件推荐

为了方便操作,可以在IDEA中安装插件 Git Commit Template
img

安装之后,提交代码的时候可以使用模板:
img


本人公众号[ 敬YES ]同步更新,欢迎大家关注~

img

作者:陈敬(公众号:敬YES)
出处:http://www.cnblogs.com/janes/
博客文章仅供交流学习,请勿用于商业用途。如需转载,请务必注明出处。

posted on 2023-09-05 23:13  敬YES  阅读(235)  评论(0)    收藏  举报
刷新页面返回顶部
博客园  ©  2004-2025
浙公网安备 33010602011771号 浙ICP备2021040463号-3