added "PEP Editor Reponsibilities & Workflow" section
This commit is contained in:
parent
500617bbff
commit
bf6eef7fdb
77
pep-0001.txt
77
pep-0001.txt
|
@ -62,7 +62,8 @@ PEP Work Flow
|
|||
|
||||
The PEP editors assign PEP numbers and change their status. The
|
||||
current PEP editors are David Goodger and Barry Warsaw. Please send
|
||||
all PEP-related email to <peps@python.org>.
|
||||
all PEP-related email to <peps@python.org> (no cross-posting please).
|
||||
Also see `PEP Editor Reponsibilities & Workflow`_ below.
|
||||
|
||||
The PEP process begins with a new idea for Python. It is highly
|
||||
recommended that a single PEP contain a single key proposal or new
|
||||
|
@ -375,6 +376,80 @@ email in a timely manner, the PEP editor will make a unilateral
|
|||
decision (it's not like such decisions can't be reversed :).
|
||||
|
||||
|
||||
PEP Editor Reponsibilities & Workflow
|
||||
=====================================
|
||||
|
||||
A PEP editor must subscribe to the <peps@python.org> list. All
|
||||
PEP-related correspondence should be sent (or CC'd) to
|
||||
<peps@python.org> (but please do not cross-post!).
|
||||
|
||||
For each new PEP that comes in an editor does the following:
|
||||
|
||||
* Read the PEP to check if it is ready: sound and complete. The ideas
|
||||
must make technical sense, even if they don't seem likely to be
|
||||
accepted.
|
||||
|
||||
* The title should accurately describe the content.
|
||||
|
||||
* Edit the PEP for language (spelling, grammar, sentence structure,
|
||||
etc.), markup (for reST PEPs), code style (examples should match PEP
|
||||
8 & 7).
|
||||
|
||||
If the PEP isn't ready, the editor will send it back to the author for
|
||||
revision, with specific instructions.
|
||||
|
||||
Once the PEP is ready for the repository, the PEP editor will:
|
||||
|
||||
* Assign a PEP number (almost always just the next available number,
|
||||
but sometimes it's a special/joke number, like 666 or 3141).
|
||||
|
||||
* List the PEP in PEP 0 (in two places: the categorized list, and the
|
||||
numeric list).
|
||||
|
||||
* Add the PEP to SVN. For Subversion repository instructions, see
|
||||
`the FAQ for Developers
|
||||
<http://www.python.org/dev/faq/#how-do-i-get-a-checkout-of-the-repository-read-only-and-read-write>`_.
|
||||
|
||||
The command to check out a read-only copy of the repository is::
|
||||
|
||||
svn checkout http://svn.python.org/projects/peps/trunk peps
|
||||
|
||||
The command to check out a read-write copy of the repository is::
|
||||
|
||||
svn checkout svn+ssh://pythondev@svn.python.org/peps/trunk peps
|
||||
|
||||
* Monitor python.org to make sure the PEP gets added to the site
|
||||
properly.
|
||||
|
||||
* Send email back to the PEP author with next steps (post to
|
||||
python-list & -dev/-3000).
|
||||
|
||||
Updates to existing PEPs also come in to peps@python.org. Many PEP
|
||||
authors are not SVN committers yet, so we do the commits for them.
|
||||
|
||||
Many PEPs are written and maintained by developers with write access
|
||||
to the Python codebase. The PEP editors monitor the python-checkins
|
||||
list for PEP changes, and correct any structure, grammar, spelling, or
|
||||
markup mistakes we see.
|
||||
|
||||
The editors don't pass judgment on PEPs. We merely do the
|
||||
administrative & editorial part. Except for times like this, there's
|
||||
relatively low volume.
|
||||
|
||||
Resources:
|
||||
|
||||
* `How Python is Developed <http://www.python.org/dev/intro/>`_
|
||||
|
||||
* `Python's Development Process <http://www.python.org/dev/process/>`_
|
||||
|
||||
* `Why Develop Python? <http://www.python.org/dev/why/>`_
|
||||
|
||||
* `Development Tools <http://www.python.org/dev/tools/>`_
|
||||
|
||||
* `Frequently Asked Questions for Developers
|
||||
<http://www.python.org/dev/faq/>`_
|
||||
|
||||
|
||||
References and Footnotes
|
||||
========================
|
||||
|
||||
|
|
Loading…
Reference in New Issue