Skip to content

Latest commit

 

History

History
66 lines (50 loc) · 1.79 KB

CONTRIBUTING.zh-CN.md

File metadata and controls

66 lines (50 loc) · 1.79 KB

贡献指南

View English / 查看英语

欢迎您的贡献!请遵循以下指南:

Fork 存储库。
为您的更改创建一个新分支。
为您的更改编写代码或文档。 使用描述性消息提交您的更改。
注意:更改消息应符合 下文 的格式
将您的分支推送到您的 fork。
向主存储库提交拉取请求。

提交消息格式

提交信息遵守以下的格式:

<类型>: <标题>
<空行>
<主体>
<空行>
<页脚>

可以仅包含第一行,也可以省略页脚。
具体含义见下文
可以安装 此 VSCode 扩展 辅助填写。

标签含义

类型

须为下列类型之一:

类型 解释
init 项目初始化
feat 添加新特性
fix 修复 bug
docs 修改文档
mod 此表以外的任何其他类型的更改
style 仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑
refactor 代码重构,没有加新功能或者修复 bug
perf 优化相关,比如提升性能、体验
test 增加测试用例
build 依赖相关的内容
ci CI 配置相关 例如对 k8s,docker 的配置文件的修改
chore 改变构建流程、或者增加依赖库、工具等
revert 回滚到上一个版本

主题

主题。
该主题包含对更改的简明描述。

页脚

可选。
页脚。
页脚应包含有关重大更改的任何信息,并且也是引用此提交关闭的 GitHub Issue 的位置。

提示

  • 使用 Prettier 格式化您的代码。
  • 切勿使用硬编码值。