浏览器家园

TAG标签|网站导航| 手机访问:m.liulanqi.com

当前位置:首页浏览器大全WebP → LiteOS Commit Message规则概要说明

LiteOS Commit Message规则概要说明

时间:2023-06-27 13:25:52来源:整理作者:浏览器知识手机版

目前,社区有多种 Commit message 的写法规范。LiteOS采用的是Angular规范,这是目前使用最广的写法,比较合理和系统化,并且有配套的工具。

Commit message的作用

格式化的Commit message有几个好处:

  • 提供更多的历史信息,方便快速浏览
  • 可以过滤某些commit(比如文档改动),便于快速查找信息。
  • 可以直接从commit生成Change log。

LiteOS Commit message的格式

每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。

<type>(<scope>): <subject>
空一行
<body>
空一行
<footer>
比如:

fix(stm32f411):fix stm32f411 migration guide file error

fix some error in stm32f411re migration guide file.

Close #75

Header格式

Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。

  • typetype用于说明 commit 的类别,只允许使用下面7个标识。feat:新功能(feature)

    fix:修补bug

    docs:文档(documentation)

    style: 格式(不影响代码运行的变动)

    refactor:重构(即不是新增功能,也不是修改bug的代码变动)

    test:增加测试

    chore:构建过程或辅助工具的变动

    如果type为feat和fix,则该 commit 将肯定出现在 Change log 之中。其他情况(docs、chore、style、refactor、test)由你决定,要不要放入 Change log,建议是不要。

  • scopescope用于说明 commit 影响的范围,比如LiteOS kernel的core修改影响全部则填写all,如果只修改stm32f411的则填写stm32f411。
  • subjectsubject是 commit 目的的简短描述,不超过50个字符。以动词开头,使用第一人称现在时,比如change,而不是changed或changes

    第一个字母小写, 结尾不加句号(.)

Body格式

Body 部分是对本次 commit 的详细描述,可以分成多行。下面是一个范例。

Add porting contest board projects to LiteOS
Board list:
Arduino-M0-PRO
ATSAM4S-XPRO
ATSAMD21-XPRO
EFM32-SLSTK3400A
EFM32-SLSTK3401A
EFM32-STK3700
FRDM-KL26Z
FRDM-KW41Z

有两个注意点。

  • 使用第一人称现在时,比如使用change而不是changed或changes。
  • 应该说明代码变动的动机,以及与以前行为的对比。

Footer格式

Footer 部分只用于两种情况。

  • 不兼容变动

如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。

BREAKING CHANGE: isolate scope bindings definition has changed.

	To migrate the code follow the example below:

	Before:

	scope: {
  		myAttr: 'attribute',
	}

	After:

	scope: {
		myAttr: '@',
	}
	The removed `inject` wasn't generaly useful for directives so there should be no code using it.
  • 关闭 Issue如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。Closes #16, #24, #92

更多参考

更详细的commit规则请参考原始的规范说明

Angular规范

相关文章

  • 谷歌浏览器每次登录,每次打开谷歌浏览器都需要登录?解决方法在这里

    谷歌浏览器每次打开需要登录的问题说明谷歌浏览器作为全球最受欢迎的浏览器之一,问题很常见,浏览器每次打开都需要登录的问题也是用户普遍遇到的问题之一。这对于用户来说是一个很不方便的体验,所以需要解决这个问题。2.问题出现的原因谷歌浏览器每次打开需要登录的问题,主要是由于浏览器在启动时没有存储用户的登录信息,或者用户的浏览器已经损坏的原因。当然,也有可能是浏览器设置的安全性问题导致的。3.解决办法(1)开启"自动登录"选项如果用户只是因为忘记勾选"自动登录"选项,导致每次..
  • 傲游云浏览器4.9.2,傲游浏览器更新至4.9.2版

    简介傲游云浏览器是一款基于Chrome内核的浏览器,更新至4.9.2版,此版本优化了多项功能,使得用户体验更加流畅和便捷。2.新功能傲游浏览器更新至4.9.2版增加了诸多实用的功能。其中最令人关注的是快速启动选项卡功能,这个功能可以让用户一键打开之前打开的多个网页,方便用户快速进行工作或娱乐。同时也加入了广告过滤功能,可以大幅度减少用户在浏览过程中受到的广告的影响。此外,还加入了“一键免费WiFi连接”功能,用户只需要将手机连接到电脑上即可自动获取可用的无线网络,十分贴心。3.更流畅的操作体验傲游云浏..

Copyright 2019-2029 www.liulanqi.com 【浏览器家园】 版权所有

浏览器家园_下载浏览器就到浏览器家园 | 专注MAC浏览器和Windows浏览器下载和使用介绍

声明: 所有软件和文章收集整理来自互联网 如有异议 请与本站联系 本站为非赢利性网站 不接受任何赞助和广告