[Python-checkins] devguide: Be a bit stronger in the opening wording; people shouldn't skip around in the

brett.cannon python-checkins at python.org
Thu Jan 6 21:44:16 CET 2011


brett.cannon pushed 2a87000c1f25 to devguide:

http://hg.python.org/devguide/rev/2a87000c1f25
changeset:   33:2a87000c1f25
user:        Brett Cannon <brett at python.org>
date:        Wed Jan 05 14:58:55 2011 -0800
summary:
  Be a bit stronger in the opening wording; people shouldn't skip around in the order of things nor skip reading period.

files:
  index.rst

diff --git a/index.rst b/index.rst
--- a/index.rst
+++ b/index.rst
@@ -7,6 +7,7 @@
    setup
    patch
    runtests
+   coverage
 
 
 .. todolist::
@@ -15,10 +16,11 @@
 Contributing
 ------------
 
-This list is in an overall suggested order for people wanting to contribute to
-the Python programming language and/or the CPython interpreter. People should
-follow the top-level bullet points in order, while sub-level bullet points can
-be done in any order.
+People who wish to contribute to Python **must** read the following documents
+in their top-level order (sub-level documents can be read in any order). You
+can stop where you feel comfortable and being contributing without reading and
+understanding all of these documents, but please do not skip around within the
+documentation.
 
 * :ref:`setup`
 * Coding style guides
@@ -27,7 +29,7 @@
 * :ref:`patch`
 * :ref:`runtests`
 * Projects to get familiar with the development process
-    * `Help increase test coverage <XXX>`_
+    * :ref:`coverage`
     * `Make all unit tests discoverable by unittest <XXX>`_
     * `Fix all warnings raised when running the test suite w/ -uall <XXX>`_
     * `Fixing documentation bugs <XXX>`_

--
Repository URL: http://hg.python.org/devguide


More information about the Python-checkins mailing list