提交拉取请求

本页面介绍如何向 tensorflow/tfhub.dev GitHub 仓库提交包含 Markdown 文档文件提交拉取请求。有关如何首先编写 Markdown 文件的更多信息，请参阅编写文档指南。

GitHub 操作检查

tensorflow/tfhub.dev 仓库使用 GitHub 操作来验证拉取请求中的文件格式。工作流用于验证 .github/workflows/contributions-validator.yml 中定义的拉取请求。您可以在工作流之外您自己的分支上运行验证器脚本，但需要确保已安装了所有正确的 PIP 软件包依赖项。

根据 GitHub 策略，首次贡献者只能在仓库维护人员批准的情况下运行自动检查。我们鼓励发布者提交一个用来修复拼写错误的小拉取请求，或改进模型文档，或提交一份只包含其发布者页面的拉取请求作为第一拉取请求，以便能够对后续拉取请求进行自动检查。

重要提示：您的拉取请求必须通过自动检查，然后才能进行审核！

提交拉取请求

可以通过以下方式之一将完整的 Markdown 文件拉取到 tensorflow/tfhub.dev 的 master 分支。

Git CLI 提交

假设确定的 Markdown 文件路径为 assets/docs/publisher/model/1.md，您可以按照标准 Git[Hub] 步骤对新增文件创建新的拉取请求。

首先需要复刻 TensorFlow Hub GitHub 仓库，然后通过此复刻分支创建拉取请求将文件拉入 TensorFlow Hub master 分支。

以下是将新文件添加到复刻仓库的 master 分支所需的典型 CLI git 命令。

git clone https://github.com/[github_username]/tfhub.dev.git
cd tfhub.dev
mkdir -p assets/docs/publisher/model
cp my_markdown_file.md ./assets/docs/publisher/model/1.md
git add *
git commit -m "Added model file."
git push origin master

GitHub GUI 提交

通过 GitHub 图形界面提交是一种更直观的方式。GitHub 支持直接通过 GUI 为新建文件或文件编辑创建拉取请求。

  1. 在 TensorFlow Hub GitHub 页面中，按 Create new file 按钮。
  2. 设置正确的文件路径：assets/docs/publisher/model/1.md
  3. 复制并粘贴现有的 Markdown 文件。
  4. 在底部，选择“Create a new branch for this commit and start a pull request”。