Skip to main content

完整步骤提交 Pull Request

感谢您考虑为我们的 Seeed Studio 文件做出贡献!

此简化的贡献流程旨在提供完整的步骤来提交文件的 PR。如果您只想添加 Markdown 文件和图片,可以查看这里

按步骤将文件提交到仓库

前提条件:git clone 仓库并在本地部署网站

点击这里,您可以在本地部署网站并查看更改!

1. 更新您的 fork 分支

2. 更新下载的文件

使用以下代码更新下载的文件。

git checkout docusaurus-version
git pull

3. 修改现有文件的内容

Wiki 平台上的所有文件都存储在 "docs" 文件夹中。

note

您想要更改的文件名通常是 URL 的最后一部分(以 Seeed Studio XIAO ESP32C3 为例)。

如果您打算添加文件

将所有新增文件(Markdown 文件和图片)存储在 "Contributor_Files" 文件夹中:

pir

4. 本地检查更改的文件

完成更新后,您可以使用以下命令查看是否显示正常。

yarn start

在编辑平台上:

image4

在本地页面上:

image5

5. 保存并将更改推送到您的 forked GitHub 仓库

如果一切正常,您可以使用以下命令将更改推送到您的 forked GitHub 仓库。

git add "您更改的文件"
git commit -m "更新:我已更新 ..."
git push

6. 提交 Pull Request 到 Seeed Studio 仓库

一旦您将更改推送到您的 GitHub 仓库,将会自动显示一个栏目。点击 "Compare & Pull Request" 按钮:

image6

向我们展示您编辑的内容并点击 "create pull request" 按钮。

image7

感谢您的贡献!

Loading Comments...