[Python-checkins] r75077 - sandbox/trunk/dev/README

[Brett Cannon]

On Sat, Sep 26, 2009 at 11:41, Doug Hellmann <doug.hellmann at gmail.com> wrote:
>
> On Sep 26, 2009, at 2:26 PM, brett.cannon wrote:
>
>> +=============
>> +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
>
> I would find it helpful if there was some guidance in this section for
> deciding when it is OK to just commit a change vs. when to put a patch in
> the tracker for review.  I understand that the line can be a little fuzzy,
> but covering the basics would be useful for new committers.
>

Under being a core developer it can be a "how/when to commit" doc.

> Would it be worth bringing the information from the Mercurial PEP into this
> part of the documentation, too?

Only once we shift to hg. Otherwise tool usage is subsumed under the
tools setup, creating a patch, and how to commit (or at least that's
how I envision it since I expect most of these to be step-by-step
guides for people to follow when starting out).

-Brett