wiki:BasicGuideToContributingCode

So, you want to contribute to Twisted?

First, a few recommendations:

  • Hang out on IRC and ask questions
  • Search trac for tickets with the 'Easy' keyword. These are low-hanging fruit and are good for first-time contributors (avoid easy tickets with the "review" keyword! another developer has already started working on these).

What you'll need:

  • Register with the site and create an account
  • A decent grasp of Twisted and what you intend to accomplish

Just the Basics

This assumes you will be working on an existing open ticket.

Checkout Source

Checkout a fresh copy of Twisted trunk. This is going to be your development branch.

git clone https://github.com/twisted/twisted twisted-trunk

Hack and Test

  1. Tests are required
  2. Docstrings are required

Hack away and then run the full Twisted test suite and make sure your new tests pass along with entire suite:

trial twisted

Submit a Patch

Follow TwistedDevelopment#SubmittingaPatch

Review Process

  1. Begin the Review process. A core developer will review your changes and give you feedback.
  2. You respond to the feedback using the ticket, attaching further patches as necessary.
  3. Once your patch is in good shape and approved, it will be accepted.
  4. A core developer will create a new branch for your ticket: description-1234, where description is a summary and 1234 is the ticket #
  5. The new branch will be merged to trunk and your contribution will be forever remembered.

Next Steps

Twisted has a rigorous development process. Now that you have a basic idea of the overall process, you can continue reading about Contributing to Twisted

Last modified 8 days ago Last modified on 05/17/2016 03:35:31 AM