首页 > 其他分享 >[git] 规范Commit格式

[git] 规范Commit格式

时间:2023-04-14 09:56:20浏览次数:45  
标签:git 示例 代码 提交 格式 Commit optional

规范Commit格式

Jenkins根据对比当次构建和上次构建的Commit信息来生成ChangeLog,但因为我们目前的提交不够规范,经常有类似"#","update"这列的提交,无法提供给PM有效的更新记录,所以建议大家尽量规范Commit格式。

Conventional Commits

目前推荐大家是有这套规范,如果大家有更好的可以推荐使用,官网链接如下:
Conventional Commits

官网介绍的很详细,要求也比较多,有一些我们可能也用不到,而且也会增加学习难度,所以我这边整理了一下适合我们的规范,比较简单,但应该够用,

格式

原文

    <type>[optional scope]: <description>
    
    [optional body]
    
    [optional footer(s)]

译文

    <类型>[可选 范围]: <描述>
    
    [可选 正文]
    
    [可选 脚注]

格式说明

示例如下:

type

  1. fix: 类型fix 的提交表示在代码库中修复了一个bug。
  2. feat: 类型feat 的提交表示在代码库中新增了一个功能。
  3. perf:类型 为 perf 的提交表示在代码库中做了性能优化。
  4. style:类型 为 style 的提交表示在不影响代码含义的变化(空白,格式化,缺少分号等)。
  5. docs:类型 为 docs 的提交表示仅更新文档。
  6. refactor:类型 为 refactor 的提交表示重构,不修复 bug 且不添加功能。

示例属于新增功能,所以使用了feat

optional scope

范围必须是一个描述某部分代码的名词,并用圆括号包围。
示例只影响到BlankSystem,所以scope写的是这次只针对BlankSystem。

description

描述字段必须直接跟在<类型>(范围) 前缀的冒号和空格之后。 描述指的是对代码变更的简短总结。
示例总结主要是为了能让非开发(PM)看懂,方便写release note,所以尽量用大家都知道的描述。

optional body

在简短描述之后,可以编写较长的提交正文,为代码变更提供额外的上下文信息。正文必须起始于描述字段结束的一个空行后。
示例简短描述是为了给非开发(PM)查看,正文是尽量让研发内部直接看懂,这里建议大家尽量写的清楚详细。

optional footer(s)

如果和每个jira相关,附带就可以

CLion示例

1. 下载插件Conventional Commit

2. Commit窗口打钩需要push的文件,然后邮件选择Commit Files...

3. Commit窗口左下角Amend左键红圈

4. Build Commit Message填好更新内容,然后会自动更新到Amend


5. Amend窗口点击Commit and Push...,然后在Push Commits to xxxx的窗口push

6. 最后在Bitbucket上可以看到提交内容

标签:git,示例,代码,提交,格式,Commit,optional
From: https://www.cnblogs.com/jiangyibo/p/17317353.html

相关文章

  • 版本管理工具Git:入门教程
    Git使用教程目录Git使用教程1.简介2.安装与配置安装配置3.Git的区域概念4.从远程创建一个新仓库①创建一个远程仓库②把远程仓库取到本地③尝试自己写个提交④再来个提交⑤把提交推送到远程仓库5.本地创建仓库并关联到远程仓库①在项目目录中新建一个仓库②创建一个空白的远程仓......
  • 配置gitee、github公钥
    1.gitee执行命令ssh-keygen-trsa-f~/.ssh/id_rsa.gitee-C"邮箱"2.github执行命令ssh-keygen-trsa-f~/.ssh/id_rsa.github-C"邮箱"3.生成公钥后,可以在C盘的.ssh目录中查看,会生成id_ras.gitee、id_ras.github文件4.到gitee/github中进行配置5.......
  • git创建版本库
    之前都是按照人家提供好的参考文档一步步使用git,发现基本没有报错,即使有报错,也能在文档中找到解决办法。但是,最近自己新装了个centos系统,想创建一个新的git版本库,发现居然出现了之前从来没有碰到过的问题。所以呢,在这篇文章中记录一下初始环境下git创建版本库的过程。 1.使用 ......
  • Git之文件名乱码
    现象利用gitstatus查看待提交的文件,其中文件名中有中文,但是显示的中文字符是乱码乱码原因在默认设置下,中文文件名在工作区状态输出,中文名不能正确显示,而是显示为八进制的字符编码。解决方式设置git的**core.quotepath**选项为false,quotepath表示引用路径,加上–global表......
  • #yyds干货盘点#Git 技巧之高级配置用户信息
    众所周知,日常配置git用户信息的方式通常是:gitconfig--globaluser.name'用户名'gitconfig--globaluser.email'邮箱'全局方式配置,写入到 ~/.gitconfig文件中,这种方式显然只能设置最常用通用的用户信息,然后在需要部分仓库(如公司项目)需要特殊配置时,只能再通过下面的方式配置......
  • git--记录
       1、由于本地的git配置的用户名、密码与gitlabs上注册的用户名、密码不一致导致   2、当操作git命令时又没有弹框提示请输入用户名密码的提示框解决方案:1、进入到本地放库目录下,然后右击选择“GitBashHere”,输入如下指令,再次git操作时会让你重新输入用户名和密码再......
  • vscode安装GitHub copliot后,不能启用,也不显示copilot图标
     这个问题可能是由于安装的GitHubCopilot版本与VSCode不兼容导致的。您可以尝试卸载当前的GitHubCopilot插件,然后重新安装一个较早的版本。如果这不起作用,您可以尝试在VSCode中打开命令面板(Ctrl+Shift+P),然后输入“GitHubCopilot:启用”以启用插件。如果您仍然无法解决问题,......
  • git常用命令汇总
    (文章目录)仓库#在当前目录新建一个Git代码库$gitinit#新建一个目录,将其初始化为Git代码库$gitinit[project-name]#下载一个项目和它的整个代码历史$gitclone[url]配置#显示当前的Git配置$gitconfig--list#编辑Git配置文件$gitconfig-e[--glob......
  • Github创建组织(organization)
    前言创建Github组织(Organization)可以让你和你的团队共享代码,更好地管理和协作开发项目。Github组织(Organization)是一个非常有用的工具,可以让开发者协同工作并共享他们的代码。首先,登录你的Github账户。Github上创建组织的详细步骤1、点击右上角的加号(+)按钮,然后从下拉菜单中选......
  • 取消git提交时precommit代码校验
    用git进行代码管理,当我执行gitcommit操作时,会出现一下代码来检测提交的代码Pro:hcf-vuehh$gitadd--allPro:hcf-vuehh$gitcommit-m'wq'husky>pre-commit(nodev8.11.2)❯Runningtasksforsrc/**/*.{js,jsx,vue}⠼eslint解决办法:1.进入项目所在文......