Pull请求标题和描述约定#
我们使用以下约定来编写pull请求标题和描述。
注意:“标题:”和“描述:”实际上没有出现
标题:<类型>(<可选范围>):<主题>描述:<body><新线><页脚><新线><依赖项>
<类型>
是:
- 专长(特征)
- 修复(错误修复)
- doc(文档)
- 样式(格式,缺少分号,…)
- 重构
- 测试(添加缺少的测试时)
- 杂务(维护)
- perf(性能改进、优化…)
<可选范围>
模块的名称或包含已更改模块的目录。这不需要包括,但如果<主题>
不足。这个马特里布
目录前缀总是被省略。例如,它可能是
<主题>
具有以下约束:
- 使用祈使句,现在时态:“change”not“changed”or“changes”
- 不要大写第一个字母
- 末尾没有点(.)
<body>
具有以下约束:
- 和中一样
<主题>
,使用祈使句、现在时
- 包括改变的动机以及与以前的对比行为
<页脚>
是可选的,可能包含两项:
- 突破性变化:所有突破性变化都必须在页脚,包含更改、对正和迁移说明
- 参考问题:关闭的错误应单独列在一行在页脚中,前缀为“Closes”关键字,如下所示:Closes#123,#456
<依赖项>
如果此PR依赖于其他人,则应将其列出以复选框格式,即。,-[]取决于:#XXXX
一个例子,其中<范围>
可能是:
专长:让图书馆搜索使用整个范围进行替换以前`是否应用?使用h`将替换为`使用h细化blah`而不是`精炼废话`.这也改变了诊断消息的整体语法`是否应用?使用h`而不仅仅是`是否应用`比特,这对我来说很好。
以及一个示例,其中包括<范围>
确实增加了价值:
docs(CategoryTheory/EssentialImage):打字和标点符号修复拼写错误,添加两个句点。
具有从属PR的示例:
专长:标准`单位化`是C⋆-标准这表明C⋆-代数总是`正则范数代数`s、 以便他们`单位化`配备了规范。此外,我们证明了该范数是C⋆-范数。- [ ]取决于:#5330
- [ ]取决于:#5741
- [ ]取决于:#5742
- [ ]取决于:#5743```