# 贡献指南

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

在提交pull request时一定要关联相应的issue，如果没有相应issue，请先创建issue</br>
关于pull request关联issue，GitHub支持自动和手动关联，具体操作请参考[Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)

issue和pull request填写时都支持Markdown，关于GitHub的Markdown语法和扩展请参考[GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github)

## 提交issue

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

## 提交pull request

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

> 如果您对以上流程还有不清楚的地方请参考[GitHub PR Flow](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests)
