跳到主要内容

维护者指南

通用

  • 成为社区的一员,并将每个人都视为社区成员。保持包容性。
  • 互相帮助并鼓励互助。
  • 积极参与并回应。
  • 保持开放的沟通。
  • 从活跃的贡献者中识别出合适的维护者候选人。

拉取请求

  • 对于新的PR,决定是否不进行审查就关闭。如果不关闭,找到合适的评审者。另一个考虑是请能从PR中受益的用户来评审。

  • 对于旧的PR,检查阻塞者:审查者或PR创建者。尝试解除阻塞。需要时寻求额外帮助。

  • 请求更改时,请确保能及时跟进,因为这会影响合并。

  • 确保所有检查已通过。

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

  • 通常,建议提出小的PR,而不是一个庞大的PR。

  • 对于文档更改,请求已编译网站的快照,或自行编译以验证格式。

  • 对于尚未签署贡献协议的新贡献者,提醒他们在审阅前签署。

  • 对于可能发生冲突的多个PR,协调它们以确定正确的顺序。

  • 请特别注意:

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

问题与讨论

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

  • 对于旧问题,提供更新或关闭。相关时鼓励创建PR。

  • 使用“good first issue”来标记适合新手贡献者的简单修复。

  • 使用“任务列表”来处理需要多个PR的问题。

  • 对于讨论,请在相关时创建一个问题。