IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: Expand organization document

Browse Source 
Provide some guidance on how one can become a core developer and explain
the different types of contribution one can make.

Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
Stephen Finucane 2020-05-30 12:29:36 +01:00
parent fa5fadc3f3
commit 227bbf6559
1 changed files with 38 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
doc/internals/organization.rst
View File

@ -1,14 +1,18 @@
===============
==================================
Organization of the Sphinx project
==================================
The guide explains how the Sphinx project is organized.
Core developers
===============
---------------
The core developers of Sphinx have write access to the main repository. They
can commit changes, accept/reject pull requests, and manage items on the issue
tracker.
You do not need to be a core developer or have write access to be involved in
the development of Sphinx. You can submit patches or create pull requests
from forked repositories and have a core developer add the changes for you.
Guidelines
~~~~~~~~~~
The following are some general guidelines for core developers:
@ -21,3 +25,32 @@ The following are some general guidelines for core developers:
* When committing code written by someone else, please attribute the original
author in the commit message and any relevant :file:`CHANGES` entry.
Membership
~~~~~~~~~~
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 :doc:`contributing` for more information on how you can get started.
Other contributors
------------------
You do not need to be a core developer or have write access to be involved in
the development of Sphinx. You can submit patches or create pull requests
from forked repositories and have a core developer add the changes for you.
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
:doc:`contributing`.
A list of people that have contributed to Sphinx can be found in
:doc:`authors`.