Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 2.36 KB
Raw

贡献指南

首先感谢您参与本开源项目，在您提交issue和pull request之前请认真阅读本指南

在提交pull request时一定要关联相应的issue，如果没有相应issue，请先创建issue 关于pull request关联issue，GitHub支持自动和手动关联，具体操作请参考Link PR to issue

issue和pull request填写时都支持Markdown，关于GitHub的Markdown语法和扩展请参考GitHub Flavored Markdown

提交issue

  1. 打开issue界面 issue
  2. 查看issue列表中是否已经存在相似issue，如果没有请点击New issue按钮
  3. 根据您的问题类型，选择不同的issue模板
  4. 填写必须项后(带红色*标记)，点击Submit new issue按钮完成提交

提交pull request

  1. Fork本仓库到您的github
  2. Clone仓库到您本地
  3. 您可以基于main分支创建新分支并添加更改git checkout -b newbranch -l main
  4. 提交您的更改到您的github
  5. 进入您的github仓库点击Pull request按钮后点击New pull request按钮
  6. 选择base repository为kendryte/k230_docs，选择base为main，选择head repository为yourname/k230_docs，选择compare为newbranch
  7. 根据pull request模板要求填写您的描述
  8. 点击Create pull request完成提交

如果您对以上流程还有不清楚的地方请参考GitHub PR Flow

Markdown检查

本项目会对上传的Markdown文件进行格式化检查和内部引用链接检查，如果不符合格式要求或存在不能访问的链接，导致PR不能被merge，因此提交PR前请确保您已在本地进行过检查。 格式检查工具使用的是markdownlint，规则配置文件是markdownlint.json。本地可使用vscode安装markdownlint来进行在线检查和格式化。也可以使用markdownlint-cli工具进行检查，执行如下命令：

docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.13.0 "**/*.md"

您也可以在提交PR之前，先push到您GitHub仓库的check分支进行CI检查，避免重复修改PR