跳到主要内容

Outreachy 2022 总结博客

·5 分钟阅读
Surbhi Sharma
Surbhi Sharma
Outreachy 实习生

这篇博客是关于我在 conda-forge 的 Outreachy 实习期间的工作。 在此之前，简单介绍一下我自己 - 我是 Surbhi，是 2022 年 5 月至 8 月期间 conda-forge 的 Outreachy 实习生，我的工作是记录 conda-forge 生态系统。

实习开始时，我着手处理的第一个问题是 更好地锚定公告(#1611)。 此问题的目标是修复每年以及“公告”部分中特定公告的锚点，以便更好地导航 公告页面。 这也是我刚开始时感到非常不知所措和焦虑的时候，我不确定自己是否能够做到最好。 但感谢我的出色导师 @Katherine 和 @Matt，他们一直非常乐于助人，我才得以顺利开始。 我们分两个部分解决了这个问题。 第一部分是为每一年添加锚点，这通过 改进“公告”部分中每年的锚点。(#1766) 解决，第二部分是为每个公告添加锚点并修复 RSS feed。

完成第一个问题后，我关注的文档部分是 维护者文档。 需要处理许多未解决的问题，以使维护者文档对新的维护者更加有用和易于访问。 我们处理过的未解决问题是

  1. 记录额外的 feedstock-name (#1769) 和 解释如何成为维护者 (#1331)。 已通过 添加额外的 section-recipe maintainer 和 feedstock-name (#1772) 关闭。

    当我们开始改进维护者文档时，这些是我们首先选择处理的问题。 第一个问题是记录维护者如何使用“feedstock-name”指令来命名 feedstock，使其与暂存配方中的包名称不同。 第二个问题是记录一个人应该如何成为软件包维护者。

  2. 在“改进文档”部分中添加更多步骤 (#1651)。 已通过 使用更多步骤更新“改进文档”部分 (#1776) 关闭。

    在此问题中，我们为想要开始为 conda-forge 贡献（尤其是文档）的人们添加了一些额外的步骤。

  3. 在文档本身中添加有关 Grayskull 的更多信息 (#1655)。 已通过 #1777 关闭。

    文档中关于 Grayskull 的文档缺少诸如 Grayskull 到底是什么以及应该如何使用 Grayskull 生成配方之类的问题的答案。 通过此问题，我们为用户添加了更多关于 Grayskull 的文档。

  4. 澄清 feedstock LICENSE.txt (#803)。 已通过 添加 Feedstock 存储库结构部分 (#1786) 关闭。

    关于贡献和维护 conda 配方的文档讨论了何时以及如何分发特定软件包的许可证。 自动生成的 feedstock 存储库还在根目录中包含一个许可证，这与相关的软件包许可证不同。 通过此问题，我们添加了关于这两个许可证之间差异的文档，并简要解释了 feedstock 存储库结构。

  5. 文档：新维护者 (#1117)。 已通过 添加“regro-cf-autotick-bot 如何创建版本更新 PR？”部分。 (#1788) 关闭。

    通过此问题，我们改进了新维护者的文档以及机器人的工作原理。 文档中添加了“regro-cf-autotick-bot 如何创建自动版本更新？”部分，其中解释了机器人创建自动版本更新 PR 的整个过程。

  6. 在文档中添加 Perl 软件包提示 (#1536)。 正在处理此 #1790。

    通过此问题，我们在文档中添加了针对具有不同构建系统的 Perl 软件包的打包说明。

  7. 文档：更新关于令牌的文档 (#1532)。 已通过 #1793 关闭。

    Feedstock 已停止存储加密令牌来上传软件包，但文档中仍然存在关于令牌的过时信息。 通过此问题，我们删除了过时的信息，并为维护者添加了一个新的部分“如何更新您的 feedstock 令牌？”。

  8. 改进关于 arch_rebuild.txt 的文档 (#1668)。 已通过 #1794 关闭。

    通过此问题，我们改进了关于 arch_rebuild.txt 的文档，以及如果 feedstock 需要使用不同的架构/平台（例如 ppc64le 或 aarch64）重建，维护者如何将 feedstock 添加到 arch-rebuild.txt。

  9. 记录迁移器 (#1355)、更新迁移文档 (#862) 和 记录迁移器 (#737) 。 已通过 记录迁移器和迁移。(#1801) 关闭。

    通过这些，我们添加了更多关于迁移和迁移器的文档，这将帮助维护者找到诸如以下问题的答案 - 什么是迁移器/迁移，它有什么作用？ 何时（以及为什么）他们应该拒绝迁移 PR？ 等等。

  10. 在文档中添加关于 conda-forge 安全方面的部分 (#1808)。 已通过 #1812 关闭。

    目前，关于 conda-forge 构建的安全注意事项的信息分散在整个文档中，因此很难找到和阅读。 通过此问题，我们将把所有信息放在一个地方，这将帮助维护者和用户更多地了解 conda-forge 如何保护其软件包和基础设施。

在实习期间，我遇到了一些很棒的人，他们帮助我解答了我的所有问题和疑虑。 实习期间的经验也帮助我在完成 Outreachy 实习后获得了更好的机会。 我在实习期间学到了很多东西，如果要写下所有这些，那将是一长串清单。 但我学到的最重要的东西是

  • 文档的重要性以及如何编写好的文档。
  • 编写文档时要遵循的最佳实践。
  • 更多关于 conda-forge 和打包工具的信息。

最重要的是，Outreachy 帮助我对自己技能更有信心，并克服了之前存在的冒名顶替综合症。 再次感谢我出色的导师和 conda-forge 社区的善良的人们！ :)