Author: brett.cannon Date: Sat Sep 26 20:26:51 2009 New Revision: 75077 Log: Add a README to document ideas on what should eventually be covered by the dev docs. As a side-effect it provides a rough outline of what the index page should end up looking like. Added: sandbox/trunk/dev/README Added: sandbox/trunk/dev/README ============================================================================== --- (empty file) +++ sandbox/trunk/dev/README Sat Sep 26 20:26:51 2009 @@ -0,0 +1,48 @@ +============= +What is This? +============= + +This directory is for the development of might (potentially) become +dev.python.org. + + +============= +What to Cover +============= + +Make sure there is a clear note saying that even experience developers of other +projects should at least peruse all documents for Python-specific tricks (e.g. +--with-pydebug). + +* Tool setup & compilation +* Source Code Tour + + + Directory structure + + Relevant PEPs (e.g. grammar and compiler PEPs, and have all future PEPs + like these just go into the docs) + +* Running and writing tests +* Creating a patch +* PEPs + + + Link to process PEP + + Link to PEP 12 (reST PEP) + +* Things anyone can do to help +* Becoming a Developer on the issue tracker + + + Bug attrition + +* Becoming a core developer + + + How to do a commit + + Helping out on the issue tracker + + +================= +What Not to Cover +================= + +* Adding a new module to the standard library + Should be a PEP on that instead w/ a link from dev +