Organization of the Sphinx project

The guide explains how the Sphinx project is organized.

Core developers

Sphinx のコア開発者は、メインリポジトリへの書き込みアクセスを持っています。コア開発者は、変更をコミットすることができ、 pull request を受理/却下することができ、課題トラッカー上のアイテムを管理することができます。



  • 不確かな変更や広範囲に及ぶ変更は、メインリポジトリに直接コミットする代わりに pull request を提出すべきです。その pull request は、マージされる前に他のコア開発者によってレビューされるべきです。

  • 自明な変更は直接コミットできますが、リポジトリを良好に動作する状態に保ち、変更を push する前にすべてのテストが通ることを確かめるようにしてください。

  • 誰か他の人によって書かれたコードをコミットする場合、コミットメッセージといずれかの適切な CHANGES エントリーの中でオリジナルの作者に言及してください。


Core membership is predicated on continued active contribution to the project. In general, prospective cores should demonstrate:

  • a good understanding of one of more components of Sphinx

  • a history of helpful, constructive contributions

  • a willingness to invest time improving Sphinx

Refer to Sphinx への貢献 for more information on how you can get started.

Other contributors

Sphinx の開発に参加するために、コア開発者である必要はなく、書き込みアクセスを持つ必要もありません。あなたはパッチを提出したり、フォークしたリポジトリから pull request を作成したりすることができます。そして、コア開発者があなたの代わりに変更を追加します。

Similarly, contributions are not limited to code patches. We also welcome help triaging bugs, input on design decisions, reviews of existing patches and documentation improvements. More information can be found in Sphinx への貢献.

A list of people that have contributed to Sphinx can be found in Sphinx 作成者.