[Twisted-Python] Contributing documentation inside CONTRIBUTING repo file

Adi Roiban adi at roiban.ro
Thu Feb 20 07:55:58 MST 2014


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.

---------

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

Thanks!
-- 
Adi Roiban
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://twistedmatrix.com/pipermail/twisted-python/attachments/20140220/1b528df8/attachment.html>


More information about the Twisted-Python mailing list