Sphinx项目的组织结构¶
该指南解释了Sphinx项目是如何组织的.
核心开发者¶
Sphinx 的核心开发者拥有主仓库的写入权限.他们可以提交更改,接受/拒绝拉取请求,并管理问题跟踪器上的项目.
指南¶
以下是核心开发者的一些一般性指南:
可疑或大规模的更改应作为拉取请求提交,而不是直接提交到主仓库. 在合并之前,拉取请求应该由另一个核心开发者进行审查.
微小的更改可以直接提交,但请确保保持代码库处于良好的工作状态,并在推送更改之前确保所有测试通过.
在提交他人编写的代码时,请在提交消息以及任何相关的
CHANGES.rst条目中注明原作者.
会员资格¶
核心成员资格基于对项目的持续积极贡献.一般来说,未来的核心成员应该展示:
对Sphinx一个或多个组件的良好理解
有帮助的、建设性的贡献历史
愿意花时间改进Sphinx
有关如何开始的更多信息,请参阅 贡献Sphinx .
其他贡献者¶
您不需要成为核心开发者或拥有写入权限就可以参与Sphinx的开发.您可以提交补丁或从分叉的代码库创建拉取请求,然后由核心开发者为您添加更改.
同样,贡献不限于代码补丁.我们也欢迎帮助进行bug分类、对设计决策的意见、对现有补丁的审查以及文档改进.更多信息可以在 贡献Sphinx 中找到.
可以在 Sphinx 作者 找到对 Sphinx 贡献的人员名单.