Skip to content

Latest commit

 

History

History
116 lines (74 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

116 lines (74 loc) · 3.68 KB

贡献指南

用语规范

本项目贡献者包括跨性别者等多元文化群体,请在贡献时尊重 ta 人,使用友善礼貌的词语。

提交规范

单个提交更改量

每一个提交只做一件事,即只适用一个 Type 字段和一个 Scope 字段。过多更改堆积在一个提交时应当按类型拆分成多个提交。

提交说明

提交说明的所有格式部分均使用英文半角标点,只有字段内容视使用语言使用全角标点,所有 CJK 字符与英文之间应插入空格。

<Type>(<Scope>): <Subject>
<空行>
<Body>
<空行>
<Footer>

Header 部分

Header 部分是提交说明的第一行,包含 <Type><Scope><Subject> 三个字段。

Type 字段

Type 字段描述提交的类型。此字段的可用值:

  • feat

    • 更改范围:代码
    • 行为:添加新功能
  • fix

    • 更改范围:代码
    • 行为:修复实际行为与预期行为不一致的问题
  • rfct(已弃用:refactor)

    • 更改范围:代码
    • 行为:重构、替换代码,不改变代码行为
  • style

    • 更改范围:代码或内容
    • 行为:更改如缩进、空格、大小写等的文本风格
  • typo

    • 更改范围:内容
    • 行为:修正没有争议的错别字
  • grammar

    • 更改范围:内容
    • 行为:修正造成阅读不畅的语法错误
  • ambig

    • 更改范围:内容
    • 行为:修正造成误解的具有歧义的内容
  • punctua

    • 更改范围:内容
    • 行为:修正标点错误
  • chore

    • 更改范围:非内容
    • 行为:杂务
  • dep

    • 更改范围:版本锁定文件
    • 行为:升级/降级依赖包
  • ci

    • 更改范围:持续集成代码
    • 行为:更改持续集成代码行为
Scope 字段

Scope 字段描述提交的更改范围。此字段为可选字段。

此字段通常使用文件名、包名、类名或方法/函数名。涉及内容的更改通常使用 <章节路径>:<更改行号> 的格式,如 11/45:14;多行更改使用 <章节路径>:<起始行号>,<结束行号> 的格式,如 19/19:8,10

如果单个提交存在许多重复更改但无法用单一 Scope 字段描述,可以使用一个分号加一个空格 ; 分隔多个 Scope 字段,如 11/45:14; 19/19:8,10。此时多个并列 Scope 字段为一个整体的 Scope 字段。

全局/大量更改请使用星号 * 填充此字段。

Subject 字段

Subject 字段用于简短地描述提交。此字段应以动词开头,并使用第一人称、一般现在时。此字段首字母小写,句尾不添加句号,中文也是如此。

特殊标签

以下标签具有特殊效果,应放置在 Subject 字段末尾:

  • [skip ci]:跳过 CI 构建

  • [skip release]:跳过发布 Release

Body 部分

Body 部分是提交说明的主体。此部分用于详细描述此提交。此部分使用第一人称、一般现在时。此字段首字母大写,句尾添加句号。

Footer 部分

Footer 部分用于承载额外内容,如关闭某个(或多个)issue,签名行。

Resolves #1, resolves #2, resolves #3
Signed-off-by: Someone <[email protected]>

或其他不应放在 Header 和 Body 部分的内容。

Revert

Revert 提交的 Header 部分应以 revert: 开头,后接被 revert 的提交的 Header,其 Body 部分应有 This reverts commit <hash>.<hash> 是被 revert 的提交的 SHA,可以附加 revert 的理由。