简述
不晓得我们在各别工程项目中是怎样写提供更多标记符的commit message, 他们工程项目有的是同僚写的很单纯,压根儿不晓得递交了什么文本,是新机能却是瑕疵复原。其本质上 commit message是为的是让团队核心成员晓得此次递交的文本,有鉴于此,他们出了两个规范化,签订合同项目组的每一同僚依照那个规范化递交标记符,达至透过message能介绍本次修正的文本。
一、commit message 的文件格式
每天递交,Commit message 都主要包括四个部份:Header,Body 和 Footer。
// 空带队拷贝标记符
当中,Header、特别针对feat和fix类别的递交文本 Body 是须要的。 无论是哪两个部份,任何人带队都严禁少于72位数(或100位数)。这是为的是防止手动转义负面影响耐用。
1.1 Header
Header部份多于带队,主要包括四个表头: type(须要)、scope(须要)和subject(须要)。
(1)type
type用作表明 commit 的类别,只容许采用上面7个标记。feat:新机能(feature)fix:修整bugdocs:文件格式(documentation)style: 文件格式(不负面影响标记符运行的发生变动)refactor:解构(即并非追加机能,也并非修正bug的标记符发生变动)test:减少试验build:构筑操作过程或基本操作的发生变动拷贝标记符
(2)scope
scope用作表明 commit 负面影响的覆盖范围,比如说分项模版、准则每边线之类,视工程项目相同而相同。
(3)subject
subject是 commit 目地的意味深长叙述,不少于50位数。1. 以代词结尾,采用第三人称那时时,比如说change,而并非changed或changes2. 第两个字母小写3. 结尾不加句号(.)拷贝标记符1.2 Body
Body 部份是对本次 commit 的详细叙述,可以分成多行。
1. 需要简要的列出各种正向或者反向的试验场景,试验透过,填pass。2. 减少修正人信息拷贝标记符二、例子2.1 feat例子feat(准则每边线、构筑、生效、仿真生效): 添加准则每边线机能1. 准则每边线主流程,引擎正常订阅,fldl生成正常。 pass2. 准则每边线,传入不存在的准则编号,异常提示。 pass递交人:xxx拷贝标记符2.2 fix例子fix(模型模块): 模型试验失败1. 导入mar模型,包含衍生表头。 pass2. 导入mar模型,不包含衍生表头。 pass递交人:xxx拷贝标记符插件推荐
idea可以安装标记符递交规范化的插件。
安装插件2.递交时选择插件递交
