Skip to main content

维护者指南

总则​

  • 成为社区的一员，对待每个人都要友善和包容。
  • 互相帮助，鼓励相互帮助。
  • 积极发布和回复信息。
  • 保持开放的沟通。
  • 从活跃的贡献者中确定合适的维护者候选人。

拉取请求​

  • 对于新的拉取请求，决定是否在没有审核的情况下关闭。如果不关闭，找到合适的审核者。可以参考 Discord 上的角色来选择。另一个考虑因素是询问可以从拉取请求中受益的用户来进行审核。

  • 对于旧的拉取请求，检查阻碍因素：审核者或拉取请求创建者。尽力解决阻碍。在需要时寻求额外的帮助。

  • 在请求更改时，请确保您能及时进行检查，因为这会阻止合并。

  • 确保所有检查都通过。

  • 对于需要运行 OpenAI 测试的更改，请确保 OpenAI 测试也通过。运行这些测试需要获得批准。

  • 一般来说，建议提交小的拉取请求，而不是一个庞大的拉取请求。

  • 对于文档更改，请请求编译后的网站快照，或者自己编译以验证格式。

  • 对于尚未签署贡献协议的新贡献者，请提醒他们在审核之前签署协议。

  • 对于可能存在冲突的多个拉取请求，请协调它们以确定正确的顺序。

  • 特别注意：

    • 破坏性更改。除非必要，否则不要进行破坏性更改。在提前提供足够的提示并准备好新版本之前，不要合并到主分支。
    • 测试覆盖率降低。
    • 可能导致性能下降的更改。当测试套件可用时，进行回归测试。
    • 当有替代方案时，不鼓励对核心库进行更改。

问题和讨论​

  • 对于新的问题，写下回复，如果相关，请应用标签。在必要时在 Discord 上提问。对于路线图问题，请应用路线图标签，并鼓励社区讨论。在必要时提及相关专家。

  • 对于旧的问题，提供更新或关闭。在必要时在 Discord 上提问。在相关时鼓励创建拉取请求。

  • 对于适合首次贡献者的简单修复，请使用“good first issue”标签。

  • 对于需要多个拉取请求的问题，请使用“task list”标签。

  • 对于讨论，如果相关，请创建一个问题。在适当的情况下在 Discord 上进行讨论。