编写您的首个社区教程

此空间专为希望与 Earth Engine 社区的其他成员分享知识的 Earth Engine 用户而设。本部分中的教程由 Earth Engine 用户创建，面向 Earth Engine 用户，适合所有水平的用户，从初学者到更高级的用户。

教程可以纯文本形式提交，也可以使用 Markdown 标记语言设置代码格式，还可以作为包含 Markdown 和可执行 Python 代码的 Colab 笔记本提交。使用 Earth Engine JavaScript 客户端库构建的教程通常以 Markdown 格式编写，而基于 Earth Engine Python 客户端库的教程则建议使用 Colab。

准备工作

行为准则

Earth Engine 团队致力于打造一个无骚扰的包容性社区。在贡献内容之前，请先熟悉我们的行为准则。

加入 GitHub

Earth Engine 社区教程通过 GitHub 进行分享和审核。如果您还没有 GitHub 账号，必须先前往 https://github.com/join 创建一个。

建议教程

在投入大量时间和精力制作新教程之前，潜在贡献者需要提交一份包含一些基本信息的简单提案。这样一来，作者就可以与 Earth Engine 开发者文档的维护者合作，专注于为 Earth Engine 用户社区提供最有价值的教程。此外，它还避免了审核流程中可能出现的反复沟通，从而节省了时间。

建议教程

首次设置

如果您是第一次向 Earth Engine 社区 GitHub 代码库提交教程，请务必在开始编写教程之前完成以下步骤：

  1. 接受贡献者许可协议 (CLA)，网址为：

    https://cla.developers.google.com

  2. 阅读并理解社区教程样式指南。

撰写和提交教程

如果您的教程提案被维护人员接受，您可以通过多种方式编辑教程并将其提交到 Earth Engine 社区代码库：

Markdown 快速入门

您可以派生 GitHub 代码库，然后直接通过 GitHub 网站创建新教程，以便快速开始，而无需使用其他工具或进行设置：

  1. 如果您尚未登录，请登录 GitHub。

  2. 如需创建和修改新的教程文件，请点击新教程。 系统会提示您克隆代码库（如果需要）。

    新教程

  3. 输入教程文件的名称，格式如下：

    your-tutorial-name/index.md

    其中，your-tutorial-name 是教程的短名称，全部采用小写字母。使用短划线 (“-”) 分隔字词。请勿在文件夹名称中使用空格或任何其他标点符号。

  4. 直接在 GitHub 文件编辑器中修改教程，使用“预览”验证格式化输出（另请参阅 GitHub 文档中的在代码库中修改文件）。

  5. 准备就绪后，提交更改并打开拉取请求。

Colab 笔记本

点击此处开始在 Colab 中撰写教程：

新的 Colab 教程

系统随即会打开一个笔记本，其中包含有关如何撰写和提交教程的说明。

高级

如果您已熟悉 GitHub、Git 和相关工具，那么提交 Markdown 和 Colab 教程的总体流程是相同的：

  1. 针对 google/earthengine-community GitHub 代码库创建分支和进行克隆。

  2. 在 tutorials 下创建一个目录，其中包含教程的 slug 化简称（例如 tutorials/my-amazing-tutorial）。

  3. 为 Markdown 或 Colab 添加相应的标头。

  4. 将教程提交到新目录，文件名为 index.md（对于 Markdown）或 tutorial.ipynb（对于 Colab）。将教程中使用的映像提交到同一目录。

  5. 将新内容推送到您的 Fork，然后打开拉取请求。

创建拉取请求时，请务必在评论部分中提及原始提案的 GitHub 问题编号。例如，如果问题是 #123，您可以在拉取请求说明中添加“Closes #123”文本，以引用原始提案，并在教程发布后自动将其标记为完成。

您打开拉取请求后，系统会指派一位或多位维护人员来审核您提交的内容。审核人员将与您合作，确保您的提交内容完整、正确，并符合 Earth Engine 社区教程样式指南。

您的拉取请求获得批准后，代码库维护人员会发布您的教程。