mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
docs: Add organization overview
Provide an introduction to how the Sphinx team is organized. This will be expanded upon in a future change. Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
parent
6a5921d7b2
commit
6b19678253
@ -212,30 +212,6 @@ The Sphinx core messages and documentations are translated on `Transifex
|
|||||||
<https://www.transifex.com/sphinx-doc/>`_ and translate them.
|
<https://www.transifex.com/sphinx-doc/>`_ and translate them.
|
||||||
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
The following are some general guidelines for core developers:
|
|
||||||
|
|
||||||
* Questionable or extensive changes should be submitted as a pull request
|
|
||||||
instead of being committed directly to the main repository. The pull
|
|
||||||
request should be reviewed by another core developer before it is merged.
|
|
||||||
|
|
||||||
* Trivial changes can be committed directly but be sure to keep the repository
|
|
||||||
in a good working state and that all tests pass before pushing your changes.
|
|
||||||
|
|
||||||
* When committing code written by someone else, please attribute the original
|
|
||||||
author in the commit message and any relevant :file:`CHANGES` entry.
|
|
||||||
|
|
||||||
|
|
||||||
Coding Guide
|
Coding Guide
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
@ -9,5 +9,6 @@ how to contribute to the project.
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
organization
|
||||||
code-of-conduct
|
code-of-conduct
|
||||||
authors
|
authors
|
||||||
|
23
doc/internals/organization.rst
Normal file
23
doc/internals/organization.rst
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
===============
|
||||||
|
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.
|
||||||
|
|
||||||
|
The following are some general guidelines for core developers:
|
||||||
|
|
||||||
|
* Questionable or extensive changes should be submitted as a pull request
|
||||||
|
instead of being committed directly to the main repository. The pull
|
||||||
|
request should be reviewed by another core developer before it is merged.
|
||||||
|
|
||||||
|
* Trivial changes can be committed directly but be sure to keep the repository
|
||||||
|
in a good working state and that all tests pass before pushing your changes.
|
||||||
|
|
||||||
|
* When committing code written by someone else, please attribute the original
|
||||||
|
author in the commit message and any relevant :file:`CHANGES` entry.
|
Loading…
Reference in New Issue
Block a user