Uploaded avatar of iHiD

新的贡献指南

@iHiD
接近3年前

如果你是因为一个被自动关闭的 Issue/PR 被引导到这里的,请不要慌张,也不要觉得被拒绝。多数情况下,你付出的努力最终都会被合并进 Exercism,或者你的问题会得到解决。我们欢迎并鼓励贡献,但更希望在 GitHub 上写代码之前先在论坛上讨论一下。在论坛上开一个帖子就能推动事情往前走。


过去一年,我们一直在尝试限制非维护者的贡献,以便腾出核心贡献者的时间,让他们能对各个轨道做出更重要的改进。 这个做法效果相当不错。 与 2022 年相比,2023 年我们新增的练习数量翻了一番,创建的教学大纲数量是之前的三倍。 这种做法的改变让更大规模的贡献成为可能,也让核心贡献者少受挫折、少被打扰。

不过,我也意识到,这给那些真心想帮忙、却感觉被我们的贡献流程挡住的新贡献者带来了挫败感。 所以今天,我想提出一些新的(或者更明确的)指导原则,说明未来几个月我们会如何推进贡献工作。

最根本的一条规则是:我们在论坛上讨论想法、bug 和 Issue,在 GitHub 上讨论由此产生的代码改动(在 PR 审查中)。 第二条规则是:先讨论,再动手(自主的维护者除外)。 我们的论坛让不同轨道的贡献者和维护者都能就各种语言和想法分享知识与经验,而不必订阅 GitHub 上 300 个不同的代码仓库,也不用被通知淹没。

更新的指导原则

获取帮助

  • 如果你在解决练习之前卡住了(例如安装 CLI、运行测试,或者卡在练习的逻辑/要求上),我们的支持渠道是论坛上的 “Exercism Support” 类别和 Discord 服务器上的 #get-help 频道。
  • 我们不通过 GitHub 或邮件处理支持请求。
  • 如果你已经完成了某个练习,但对它有疑问,应该直接在 Exercism 上申请指导。

报告 bug/Issue

  • 所有 bug/Issue 都应该发到我们的论坛,那里有各种各样的人可以帮忙理解和解决问题。
    • 如果问题与某门语言有关,请使用相应的 Programming/xxx 类别。
    • 如果是网站上的 bug,请使用 “Bugs & Feature Requests” 类别。
  • GitHub 上的 Issue 通常会被自动关闭,发帖人会被引导到论坛(并附上一个一键链接,方便他们复制粘贴自己的 Issue,和目前的做法一样)。
  • 轨道维护者可以选择关闭自动关闭 Issue 的功能,但官方途径仍然是论坛。

发起 PR

  • 在动手之前,PR 应该先在论坛上讨论。
  • 来自非组织成员的 PR 仍会被自动关闭,但一旦工作内容在论坛上讨论过,通常会被重新打开。 如果某个 PR 背后的想法已经获批,只需在相关的论坛帖子里加上该 PR 的链接,我们就会重新打开它。
  • 轨道维护者可以选择关闭自动关闭 PR 的功能,但我们仍然建议所有 PR 都先在论坛上讨论。

总结

我们的首要任务仍然是保护核心贡献者的时间和精力,没有他们,Exercism 就无法运转。 但我们也希望确保 Exercism 仍然是一个新人能够参与进来、门槛不会高得让人望而却步的地方,也是一个我们能鼓励并支持这些人自己成长为核心贡献者的地方!

我很期待看到这些变化会如何影响未来几个月的贡献情况。 我们会在 2024 年年中再复盘一次。

Translation missing: zh-CN.number.nth.ordinalized Nov 2023 · 觉得有用吗?