作品提交指南

在最终评估中，所有参与的贡献者都必须提供指向他们为该计划所完成工作的链接。否则可能会导致程序失败。您可以通过多种不同的方式完成迁移，因此请仔细阅读本文档。

这些链接将在 GSoC 项目的公开归档中发布。他们可帮助演示在项目中完成的工作。这也是您回头向未来雇主所做工作的好方法。您希望人们能够快速了解您的项目目标、实现的内容、代码所在位置以及任何潜在的后续步骤。

我们在过去几年看到的最佳示例是“最终报告”，其中包含：

  • 项目目标的简短说明。
  • 你做了什么。
  • 当前状态。
  • 剩下要做的事了。
  • 哪些代码已合并（或未合并）上游。
  • 您在项目期间遇到的任何挑战或学到的重要知识。

如需查看示例，请先查看 2022 年项目列表，随机选择项目，然后点击“查看代码”。请注意，其中许多项目未遵循我们的建议，这只会对他们展示自己的工作造成不利影响。

致贡献者注意：提交最终提交的工作后，您可以在最终提交截止日期之前对其进行修改。

在提交评估之前，您应将链接分享给导师，以确保其符合他们的预期。

要求

  • 您必须能够轻松识别您完成的工作。（即您所做的更改或新代码）。
    • 当用户访问提供的网址时，应该很清楚您做了什么工作，而无需进行大量额外挖掘。
  • 文件应存放在稳定的位置。该网址在提交后便无法更改。
  • 他人应该能够使用链接目标处（或引用自）的内容来扩展您的工作。
    • 如果您的工作已完成 100%，他们应该可以使用它。
    • 如果您的工作并没有 100% 完成，应该清楚地知道还剩下什么。

正面示例

您无需执行所有（或任何）操作，但您可以通过这些方法满足相关要求。

  • 创建博文、网页或公共 GitHub 要点，描述您已完成的工作，并链接到您已提交的内容和处理的代码库。如果项目中仍有要完成的工作，也请一并提交。您还可以分享精彩集锦或具有挑战性的作品。
    • ❗ 这是最佳选项，因为它可以让您轻松添加大量信息。这样做非常好，因为它可以清楚地显示您所做的工作，并且让其他人可以轻松使用和理解您的代码。
  • 如果使用 GitHub，并且您的所有工作都由单个拉取请求涵盖，您可以使用该链接。
    • 确保拉取请求说明详细说明。（请参阅上方针对博文内容的建议。）
    • 确保说明中明确指出这是 Google 编程之夏。
    • 如果拉取请求在 GSoC 结束后需要完成更多工作，请务必记下最后一次 GSoC 提交。
    • ❗ 此示例将更新日志、提交列表和评价意见汇集于一处。
  • 如果您的 GitHub 代码库是 GSoC 的单一用途，请添加包含更多详细信息的 README.md。
  • 向公开归档的开发者邮寄名单发送电子邮件，并附上上述内容以及相应链接。
  • 在 Google 云端硬盘中创建一个公共文件夹，并添加您创建的所有补丁。
  • 使用 Google 表格创建公开的电子表格，并列出您的所有提交内容。
  • 链接到一个明显包含对作品和任何其他适当内容的引用的 bug。它应该跟踪您完成的所有工作。确保在其中列出所有提交内容，或以其他方式轻松找到这些内容。
  • 指向所做更改的统一或情境差异的链接。请务必添加标题，注明项目适用于什么项目以及您是谁，以便对其他人非常有用。

反面示例

请勿做这些事。

  • 指向包含整个项目的源代码或工作目录的 tarball/zip 文件的链接。（太多人都这样做已经过去了，对于希望详细了解您所做的工作的人而言，这没什么帮助。）
  • 指向项目主要源代码库顶部的链接。
  • 指向项目源代码库的克隆的链接。
    • 这使您很难看出具体更改内容，因为您的工作内容与其他内容混在一起。
  • 指向您的 GSoC 项目页面的链接。
    • 我们已经知道这是什么。（即 https://summerofcode.withgoogle.com/projects/#1234567890）

导师

请帮助您的贡献者正确提交代码。请务必在工作的最终提交期限之前执行此操作。

请检查...

  • 提交内容符合上述要求。
  • 代码会编译。
  • 我们提供了相关文档，其中介绍了具体内容及其原因。

GSoC 的理念并不意味着贡献者大量使用代码，重要的是，代码对于托管开源项目可能很有用。