<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On 20 February 2014 17:13,  <span dir="ltr"><<a href="mailto:exarkun@twistedmatrix.com" target="_blank">exarkun@twistedmatrix.com</a>></span> wrote:<br>

<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="HOEnZb"><div class="h5">On 02:55 pm, <a href="mailto:adi@roiban.ro" target="_blank">adi@roiban.ro</a> wrote:<br>


<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Hi.<br>
<br>
Right now CONTRIBUTING file from twisted repo sends developers to:<br>
<a href="https://twistedmatrix.com/trac/wiki/ContributingToTwistedLabs" target="_blank">https://twistedmatrix.com/<u></u>trac/wiki/<u></u>ContributingToTwistedLabs</a><br>
<br>
What do you think about having basic contributing documentation inside the<br>
repo?<br>
I am talking about these 2 pages:<br>
<br>
<a href="https://twistedmatrix.com/trac/wiki/BasicGuideToContributingCode" target="_blank">https://twistedmatrix.com/<u></u>trac/wiki/<u></u>BasicGuideToContributingCode</a><br>
<a href="https://twistedmatrix.com/trac/wiki/TwistedDevelopment" target="_blank">https://twistedmatrix.com/<u></u>trac/wiki/TwistedDevelopment</a><br>
<br>
Commiters Check list can be left on the wiki page:<br>
<a href="https://twistedmatrix.com/trac/wiki/CommitterCheckList" target="_blank">https://twistedmatrix.com/<u></u>trac/wiki/CommitterCheckList</a><br>
<br>
--------<br>
<br>
I think that those pages are very important to assist new developers in<br>
creating a successful patch (ie one that is merged without to much<br>
ping-pong)<br>
<br>
Even if I now have wiki edit page, I don't have the courage to change the<br>
wiki page (for example to add information about twistedchecker or how to<br>
build the new docs).<br>
<br>
Changing a file and submitting for review feels more comfortable.<br>
<br>
Also, developers could always refer to that file from inside their<br>
preferred text editor.<br>
</blockquote>
<br></div></div>
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.<br>

</blockquote><div><br></div><div>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.</div>

<div><br></div><div>Thanks!</div></div>-- <br>Adi Roiban
</div></div>