[Twisted-Python] code contribution/participation policy

Hi all,
I have started working with Twisted and found it to be a very powerful package. That said, some modules are not documented very thoroughly (big surprise in the world of software, right?) and I also found some questionable code, too.
If I were to contribute fixes/improvements, what is the submission procedure?
Thanks.
Boris.

Hi Boris,
Probably the best starting point is https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions#RequestsandCont... and specifically https://twistedmatrix.com/trac/wiki/ContributingToTwistedLabs and https://twistedmatrix.com/trac/wiki/TwistedDevelopment
There are a lot of little details in those documents, please read them carefully... but overall, the process is (1) Find/make a ticket (on trac, not github), (2) Make a github pull request, and (3) set the trac ticket up to be reviewed.
Happy hacking!
Colin
On Fri, Aug 21, 2020 at 7:36 PM Boris Epstein borepstein@gmail.com wrote:
Hi all,
I have started working with Twisted and found it to be a very powerful package. That said, some modules are not documented very thoroughly (big surprise in the world of software, right?) and I also found some questionable code, too.
If I were to contribute fixes/improvements, what is the submission procedure?
Thanks.
Boris. _______________________________________________ Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python

Welcome, Boris!
If you're looking for stuff to work on, please feel free to discuss on this list. We absolutely could use more volunteers to maintain stuff, particularly improving the documentation!
-glyph
On Aug 21, 2020, at 12:04 PM, Colin Dunklau colin.dunklau@gmail.com wrote:
Hi Boris,
Probably the best starting point is https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions#RequestsandCont... https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions#RequestsandContributing and specifically https://twistedmatrix.com/trac/wiki/ContributingToTwistedLabs https://twistedmatrix.com/trac/wiki/ContributingToTwistedLabs and https://twistedmatrix.com/trac/wiki/TwistedDevelopment https://twistedmatrix.com/trac/wiki/TwistedDevelopment
There are a lot of little details in those documents, please read them carefully... but overall, the process is (1) Find/make a ticket (on trac, not github), (2) Make a github pull request, and (3) set the trac ticket up to be reviewed.
Happy hacking!
Colin
On Fri, Aug 21, 2020 at 7:36 PM Boris Epstein <borepstein@gmail.com mailto:borepstein@gmail.com> wrote: Hi all,
I have started working with Twisted and found it to be a very powerful package. That said, some modules are not documented very thoroughly (big surprise in the world of software, right?) and I also found some questionable code, too.
If I were to contribute fixes/improvements, what is the submission procedure?
Thanks.
Boris. _______________________________________________ Twisted-Python mailing list Twisted-Python@twistedmatrix.com mailto:Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python _______________________________________________ Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python

Hi Glyph,
Thanks.
So I presume I should just follow the procedures delineated below, right?
It makes sense - you identify an issue, document it and then work on it.
Regards,
Boris.
On Sat, Aug 22, 2020 at 1:54 AM Glyph glyph@twistedmatrix.com wrote:
Welcome, Boris!
If you're looking for stuff to work on, please feel free to discuss on this list. We *absolutely* could use more volunteers to maintain stuff, particularly improving the documentation!
-glyph
On Aug 21, 2020, at 12:04 PM, Colin Dunklau colin.dunklau@gmail.com wrote:
Hi Boris,
Probably the best starting point is https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions#RequestsandCont... and specifically https://twistedmatrix.com/trac/wiki/ContributingToTwistedLabs and https://twistedmatrix.com/trac/wiki/TwistedDevelopment
There are a lot of little details in those documents, please read them carefully... but overall, the process is (1) Find/make a ticket (on trac, not github), (2) Make a github pull request, and (3) set the trac ticket up to be reviewed.
Happy hacking!
Colin
On Fri, Aug 21, 2020 at 7:36 PM Boris Epstein borepstein@gmail.com wrote:
Hi all,
I have started working with Twisted and found it to be a very powerful package. That said, some modules are not documented very thoroughly (big surprise in the world of software, right?) and I also found some questionable code, too.
If I were to contribute fixes/improvements, what is the submission procedure?
Thanks.
Boris. _______________________________________________ Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python
Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python
Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python

Hello all,
Thanks again for your help.
OK, so I think I have taken the first step:
https://twistedmatrix.com/trac/ticket/9951
Now how do I proceed? What is the convention for Git brach names, etc?
Cheers,
Boris.
On Sat, Aug 29, 2020 at 9:39 AM Boris Epstein borepstein@gmail.com wrote:
Hi Glyph,
Thanks.
So I presume I should just follow the procedures delineated below, right?
It makes sense - you identify an issue, document it and then work on it.
Regards,
Boris.
On Sat, Aug 22, 2020 at 1:54 AM Glyph glyph@twistedmatrix.com wrote:
Welcome, Boris!
If you're looking for stuff to work on, please feel free to discuss on this list. We *absolutely* could use more volunteers to maintain stuff, particularly improving the documentation!
-glyph
On Aug 21, 2020, at 12:04 PM, Colin Dunklau colin.dunklau@gmail.com wrote:
Hi Boris,
Probably the best starting point is https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions#RequestsandCont... and specifically https://twistedmatrix.com/trac/wiki/ContributingToTwistedLabs and https://twistedmatrix.com/trac/wiki/TwistedDevelopment
There are a lot of little details in those documents, please read them carefully... but overall, the process is (1) Find/make a ticket (on trac, not github), (2) Make a github pull request, and (3) set the trac ticket up to be reviewed.
Happy hacking!
Colin
On Fri, Aug 21, 2020 at 7:36 PM Boris Epstein borepstein@gmail.com wrote:
Hi all,
I have started working with Twisted and found it to be a very powerful package. That said, some modules are not documented very thoroughly (big surprise in the world of software, right?) and I also found some questionable code, too.
If I were to contribute fixes/improvements, what is the submission procedure?
Thanks.
Boris. _______________________________________________ Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python
Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python
Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python

On Sat, Sep 5, 2020 at 10:25 AM Boris Epstein borepstein@gmail.com wrote:
Now how do I proceed? What is the convention for Git brach names, etc?
This document should give you the steps to create a Git branch and proceed with a PR:
https://twistedmatrix.com/trac/wiki/TwistedDevelopment#SubmittingaPatch
-- Craig

Hello Craig,
Thanks. So basically you just work on the main Git repo, not on a clone - and you do the pull directly, not submit a pull request?
Boris.
On Sat, Sep 5, 2020 at 2:19 PM Craig Rodrigues rodrigc@crodrigues.org wrote:
On Sat, Sep 5, 2020 at 10:25 AM Boris Epstein borepstein@gmail.com wrote:
Now how do I proceed? What is the convention for Git brach names, etc?
This document should give you the steps to create a Git branch and proceed with a PR:
https://twistedmatrix.com/trac/wiki/TwistedDevelopment#SubmittingaPatch
-- Craig _______________________________________________ Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python

On Sep 14, 2020, at 10:11 AM, Boris Epstein borepstein@gmail.com wrote:
Hello Craig,
Thanks. So basically you just work on the main Git repo, not on a clone - and you do the pull directly, not submit a pull request?
Boris.
Hi Boris,
No, not at all. Work on your clone, and submit a PR as normal. The PR template should walk you through the rest.
-g

Hello all,
Thank you.
Just submitted my first PR into the Twisted repo. Hopefully it is all good.
Here's the relevant ticket: https://twistedmatrix.com/trac/ticket/9951
Cheers,
Boris.
On Mon, Sep 14, 2020 at 1:49 PM Glyph glyph@twistedmatrix.com wrote:
On Sep 14, 2020, at 10:11 AM, Boris Epstein borepstein@gmail.com wrote:
Hello Craig,
Thanks. So basically you just work on the main Git repo, not on a clone - and you do the pull directly, not submit a pull request?
Boris.
Hi Boris,
No, not at all. Work on your clone, and submit a PR as normal. The PR template should walk you through the rest.
-g _______________________________________________ Twisted-Python mailing list Twisted-Python@twistedmatrix.com https://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python
participants (4)
-
Boris Epstein
-
Colin Dunklau
-
Craig Rodrigues
-
Glyph