[Python-Dev] Revamping the bug/patch guidelines (was Re: Implementation of PEP 341)

[Nick Coghlan]

Brett Cannon wrote:
> On 11/13/05, Nick Coghlan <ncoghlan at gmail.com> wrote:
>> Thomas Lee wrote:
>>> Implemented as you suggested and tested. I'll submit the patch to the
>>> tracker on sourceforge shortly. Are you guys still after contextual
>>> diffs as per the developer pages, or is an svn diff the preferred way to
>>> submit patches now?
>> svn diff should be fine. Although I thought Brett had actually updated those
>> pages after the move to svn. . .
>>
> 
> I did.  But the docs just need to be revamped.  But I can't start on
> that work until people tell me if they prefer FAQ-style (question
> listing all steps and then a question covering each step) or
> essay-style (bulleted list and then a definition/paragraph on each
> step) for bug/patch guidelines.

I'd prefer essay-style for the guidelines themselves, with appropriate 
pointers to the guidelines from the dev FAQ.

However, I also think either approach will work, so I suggest going with 
whichever you find easier to write :)

Cheers,
Nick.

-- 
Nick Coghlan   |   ncoghlan at gmail.com   |   Brisbane, Australia
---------------------------------------------------------------
             http://boredomandlaziness.blogspot.com