[Git CLion] 规范Commit格式

这篇具有很好参考价值的文章主要介绍了[Git CLion] 规范Commit格式。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

规范Commit格式

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

Conventional Commits

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

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

格式

原文

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

译文

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

格式说明

示例如下:
[Git CLion] 规范Commit格式

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

[Git CLion] 规范Commit格式

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

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

[Git CLion] 规范Commit格式

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

[Git CLion] 规范Commit格式
[Git CLion] 规范Commit格式

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

[Git CLion] 规范Commit格式

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

[Git CLion] 规范Commit格式文章来源地址https://www.toymoban.com/news/detail-412951.html

到了这里,关于[Git CLion] 规范Commit格式的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Git commit代码规范校验

    在团队协作开发中,遵循一致的代码提交规范是至关重要的。Git commit规范可以帮助团队成员更好地理解每个提交所做的更改,提高代码可读性和维护性。 需要用到两个工具:husky 和 commitlint Husky是一个可以让我们使用Git hooks的工具,通过配置pre-commit钩子函数,在代码提交前

    2024年02月11日
    浏览(36)
  • Git Commit Message规范

    Git commit message规范是一种良好的实践,可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。下面是一种常见的Git commit message规范,通常被称为\\\"Conventional Commits\\\"规范: 每次提交,Commit message 都包括三个部分: Header , Body 和 Foot

    2024年04月14日
    浏览(36)
  • Git —— Commit Message 规范介绍

    日常开发中,我们经常会使用到 Git 进行代码管理,而 Git 中最常用的命令就是 git commit ,我们通过 commit 命令将修改后的代码提交到本地仓库,然后再通过 git push 命令将本地仓库的代码推送到远程仓库。 git 规定提交时必须要写提交信息,作为改动说明,保存在 commit 历史中

    2024年02月03日
    浏览(45)
  • 开发软技能——Git Commit规范

    提交代码是程序员们每天的工作日常,今天敬姐给大家分享一个好的编程习惯,就是关于Git Commit规范。 提交之后的效果如下: type: 必填 commit 类型,有业内常用的字段,也可以根据需要自己定义 feat 增加新功能 fix 修复问题/BUG style 代码风格相关无影响运行结果的 perf 优化

    2024年02月10日
    浏览(132)
  • Git Commit 之道:规范化 Commit Message 写作指南

    commit message格式都包括三部分:Header,Body和Footer Header是必需的,Body和Footer则可以省略 Type(必需) type用于说明 git commit 的类别,允许使用下面几个标识。 feat :新功能(Feature) \\\"feat\\\"用于表示引入新功能或特性的变动。这种变动通常是在代码库中新增的功能,而不仅仅是修

    2024年02月03日
    浏览(43)
  • git 学习 之一个规范的 commit 如何写

    最好的话做一件完整的事情就提交一次

    2024年02月04日
    浏览(45)
  • 统一git使用方法,git状态变迁图,git commit提交规范

    目录 说明 统一git使用方法 git状态变迁图 git commit 提交规范 多次工作中多名员工不懂git多次技术分享,自行查资料学习git并使用,会出现使用各种偏僻的命令,异常问题无法解决;或出现带url的git合并提交;接触git1年一直在请教求助一直未入门。主要是学的不对,培训的不

    2024年02月11日
    浏览(33)
  • 一文教你如何设置git commit模板规范

    今天看公司代码的提交历史,发现信息量过少,甚至是误导的commit message非常常见,并且无法定位到禅道的相关任务(有的公司用的是jira),对新人来说,查找以往的提交记录很不友好。 为方便新人更快更准确的理解工程师所提交的需求或缺陷,git在提交时需要指定格式提交

    2024年02月11日
    浏览(26)
  • 工作中如何打造优雅的Git工作流和Commit规范!

    前言 🤓Git大家都非常熟悉了,就不做过多介绍,但是如何用好Git、如何进行合理的分支开发、Merge你是否有一个规范流程呢?💤 不论是一个团队一起开发一个项目,还是自己独立开发一个项目,都少不了要和Git打交道,这些都是作为开发者必须要掌握的。每个团队也许有自

    2024年01月21日
    浏览(39)
  • 结合企业实践来规范你的Git commit(含插件使用指南)

    🏆 文章目标:了解通用的Git commit规范,并在企业的团队内部进行实践。 🍀 如何规范你的Git commit(理论结合企业的实践) ✅ 创作者:Jay… 🎉 个人主页:Jay的个人主页 🍁 展望:若本篇讲解内容帮助到您,请帮忙点个赞吧,再点点您的小手关注下,您的支持是我继续写作

    2023年04月14日
    浏览(35)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包