Sphinx 项目的组织

本指南解释了 Sphinx 项目是如何组织的。

核心开发者

Sphinx 的核心开发者拥有主仓库的写入权限。他们可以提交更改、接受/拒绝拉取请求,以及管理问题跟踪器上的条目。

指南

以下是针对核心开发者的一些通用指南

  • 有疑问或大量的更改应该作为拉取请求提交,而不是直接提交到主仓库。拉取请求在合并之前应由另一位核心开发者审查。

  • 小的更改可以直接提交,但请确保仓库保持良好的工作状态,并在推送更改之前所有测试都通过。

  • 当提交由其他人编写的代码时,请在提交消息和任何相关的 CHANGES.rst 条目中注明原始作者。

成员

核心成员资格取决于对项目的持续积极贡献。一般来说,有希望成为核心成员的人应该展现出

  • 对 Sphinx 的一个或多个组件的良好理解

  • 有益的、建设性的贡献历史

  • 愿意投入时间改进 Sphinx

有关如何开始的更多信息,请参阅 贡献 Sphinx

其他贡献者

您不需要成为核心开发者或拥有写入权限即可参与 Sphinx 的开发。您可以从 Fork 的仓库提交补丁或创建拉取请求,并让核心开发者为您添加更改。

同样,贡献不限于代码补丁。我们也欢迎帮助分类错误、对设计决策的投入、对现有补丁的审查和文档改进。更多信息可以在 贡献 Sphinx 中找到。

可以在 Sphinx 作者 中找到对 Sphinx 做出贡献的人员列表。