[Twisted-Python] Contributing documentation inside CONTRIBUTING repo file

exarkun at twistedmatrix.com exarkun at twistedmatrix.com
Thu Feb 20 08:13:22 MST 2014


On 02:55 pm, adi at roiban.ro wrote:
>Hi.
>
>Right now CONTRIBUTING file from twisted repo sends developers to:
>https://twistedmatrix.com/trac/wiki/ContributingToTwistedLabs
>
>What do you think about having basic contributing documentation inside 
>the
>repo?
>I am talking about these 2 pages:
>
>https://twistedmatrix.com/trac/wiki/BasicGuideToContributingCode
>https://twistedmatrix.com/trac/wiki/TwistedDevelopment
>
>Commiters Check list can be left on the wiki page:
>https://twistedmatrix.com/trac/wiki/CommitterCheckList
>
>--------
>
>I think that those pages are very important to assist new developers in
>creating a successful patch (ie one that is merged without to much
>ping-pong)
>
>Even if I now have wiki edit page, I don't have the courage to change 
>the
>wiki page (for example to add information about twistedchecker or how 
>to
>build the new docs).
>
>Changing a file and submitting for review feels more comfortable.
>
>Also, developers could always refer to that file from inside their
>preferred text editor.

There is currently an effort to re-organize the contributor 
documentation underway.  Given its fragile state, I wouldn't want to 
disturb it sending work off in a different direction.  On the other 
hand, if you'd like to take over and complete it, feel free to take 
whatever direction you like. :)  Either way I suggest you try to 
coordinate with the folks working on that.

Jean-Paul
>
>Is there someone review-ul changes on the wiki pages?

I hope people read changes made to the wiki.  I usually do.

Jean-Paul



More information about the Twisted-Python mailing list