侧边栏壁纸
博主头像
木易成

聊聊软件、聊聊金融、聊聊篮球

  • 累计撰写 29 篇文章
  • 累计创建 18 个标签
  • 累计收到 3 条评论

目 录CONTENT

文章目录

代码提交规范

木易成
2022-11-11 / 1 评论 / 0 点赞 / 2,633 阅读 / 557 字

代码提交规范

规范说明

一、 commit的作用

Git Commit:指的是提交说明,用于标注此次修改的内容以及需要提示的信息,官方给出的解释是:Record changes to the repository(记录添加到仓库当中的修改):
比如我想将工程上传到Github当中并希望团队的负责人审查之后,将我的功能模块并入到主模块当中,这个时候就需要告诉这个负责人我修改了什么,尤其在面对非常多的提交的时候,让负责人尽快地定位到关键内容,查看Commit信息就显得非常重要了

二、 标准参数

格式要求包括三个部分: Header,Body和Footer;其中,header 是必需的,body 和 footer 可以省略。

<type>(<scope>): <subject>
<BLANK LINE> #空行的意思
 <body>
<BLANK LINE>
<footer>
  1. Header
    Header部分只有一行,包括三个字段:type 、scope、subject,header为必填
    type 用于说明 commit 的类别,只允许使用下面7个标识。

    feat:新功能(feature)
    fix:修补bug
    docs:文档(documentation)
    style: 格式(不影响代码运行的变动)
    refactor:重构(即不是新增功能,也不是修改bug的代码变动)
    test:增加测试
    chore:构建过程或辅助工具的变动

    scope:用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
    subject:是commit目的的简短描述,不超过50个字符。用于填写coding上的故事名称

  2. Body
    Body 部分是对本次 commit 的详细描述,可以分成多行。可填写coding上的子任务及详细描述

  3. Footer
    不兼容变动,以BREAKING CHANGE开头的Footer,主要用在当前代码和上一个版本不适应的时候
    关闭 Issue,示例:close # 234 coding编号

插件安装

idea:Settings -> Plugins ->Git Commit Template 安装
SourceTree:示例
SourceTree

参考文献

Git Commit Message Conventions

0

评论区