On 20 February 2014 17:13, <exarkun@twistedmatrix.com> wrote:
On 02:55 pm, adi@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.
Thanks for the reply. I am happy to coordinate with folks working on contributor documentation re-organization, but I have idea how exactly I am supposed to do that and who is working on this task. Thanks! -- Adi Roiban