Sphinx 项目组织

本指南解释了 Sphinx 项目的组织方式。

核心开发者

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

指南

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

  • 有疑问或大规模更改应以拉取请求的形式提交,而不是直接提交到主仓库。拉取请求应在合并之前由另一位核心开发者进行审查。

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

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

成员资格

核心成员资格以对项目的持续积极贡献为前提。一般而言,潜在的核心成员应证明

  • 对 Sphinx 的一个或多个组件有很好的了解

  • 有提供有益且建设性贡献的历史

  • 愿意投入时间改进 Sphinx

有关如何入门的更多信息,请参阅 为 Sphinx 做贡献

其他贡献者

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

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

您可以在 Sphinx 作者 中找到所有为 Sphinx 做过贡献的人员的列表。