diff options
author | Stephen Finucane <stephen@that.guru> | 2020-05-30 12:29:36 +0100 |
---|---|---|
committer | Stephen Finucane <stephen@that.guru> | 2020-06-02 12:13:31 +0100 |
commit | 227bbf6559b5802dd42930aa623be702f67a03b6 (patch) | |
tree | b51fb3f1ece209d6e3d9611ff8d485183323a19c | |
parent | fa5fadc3f3f93bcb419f539c83b9b8e2aab89b19 (diff) | |
download | sphinx-git-227bbf6559b5802dd42930aa623be702f67a03b6.tar.gz |
docs: Expand organization document
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>
-rw-r--r-- | doc/internals/organization.rst | 43 |
1 files changed, 38 insertions, 5 deletions
diff --git a/doc/internals/organization.rst b/doc/internals/organization.rst index ea5e14ea0..4fc159845 100644 --- a/doc/internals/organization.rst +++ b/doc/internals/organization.rst @@ -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`. |