Contributing To Twisted
#######################


.. contents::

There are many ways individuals and organizations can make contributions to Twisted.

Many open source projects are perpetually crunched for volunteer labor. Twisted is no different in this respect — we could always use more help from the community.  However, we are lucky to have something that most projects don't: the ability to convert dollars directly into maintenance that benefits the project.

When you contribute money to the Twisted project, you are directly contributing to get bugs fixed, features implemented, and tickets reviewed.
Donations are `tax-deductible </sphinxwiki/content/pages/Twisted/TwistedSoftwareFoundation.html#background>`_ and can be made via `Google Checkout or Paypal <http://twistedmatrix.com/>`_ or directly to the `Twisted Software Foundation </sphinxwiki/content/pages/Twisted/TwistedSoftwareFoundation.html>`_.

Code Contributions
==================

Overview
--------

* `Submitting a Patch </sphinxwiki/content/pages/Twisted/TwistedDevelopment.html#submitting-a-patch>`_, a simplified overview
* `Detailed Contribution Requirements </sphinxwiki/content/pages/Twisted/TwistedDevelopment.html>`_, with that and more
* `Review Process </sphinxwiki/content/pages/ReviewProcess.html>`_, how contributed code is quality checked and reviewed
* `Checklist for Twisted committers </sphinxwiki/content/pages/CommitterCheckList.html>`_, things that developers with commit access should know


Prepare
-------
* Get a GitHub account and then come back and `Login using GitHub </fixme/github/login>`_ on this site

* Intimately familiarize yourself with `The Ultimate Quality Development System </sphinxwiki/content/pages/UltimateQualityDevelopmentSystem.html>`_

* Understand the `Developer docs </index.html>`_ (how-tos, core docs, examples, API reference)

* Twisted has a rigorous policy standards for code, documentation, and testing:

  * `Coding standard <http://twistedmatrix.com/documents/current/core/development/policy/coding-standard.html>`_

  * `Writing Style guide <http://twistedmatrix.com/documents/current/core/development/policy/writing-standard.html>`_

  * `Testing standard <http://twistedmatrix.com/documents/current/core/development/policy/test-standard.html>`_

  * `Git Access <https://github.com/twisted/twisted/blob/trunk/docs/core/development/policy/code-dev.html>`_

* Understand the `Review Process </sphinxwiki/content/pages/ReviewProcess.html>`_ code review process

* Multiple CI services are used to automate the build process across platforms and test for breakage. Watch their feedback on each pull request page.

Explore and Contribute
----------------------

* Examine some of the `sources <https://github.com/twisted/twisted/repository/>`_

* Take a look at the `open tickets </fixme/report/>`_ open tickets

* Learn the `bug keywords </sphinxwiki/content/pages/BugKeywords.html>`_

  * `'Easy' keyword tickets </fixme/query?status=new&status=assigned&status=reopened&keywords=%7Eeasy&order=priority>`_ are low-hanging fruit and good to get your feet wet

* `Submit a Patch </sphinxwiki/content/pages/Twisted/TwistedDevelopment.html#submitting-a-patch>`_

* Learn how to apply for commit privileges with the `Contributor Advancement Path </sphinxwiki/content/pages/ContributorAdvancementPath.html>`_

Other Ways to Contribute
========================

* `Review and add documentation </sphinxwiki/content/pages/ReviewingDocumentation.html>`_
* `Code Reviews </sphinxwiki/content/pages/ReviewProcess.html>`_
* Submit bug reports (you must first be `registered </fixme/register/>`_)
* Provide technical support (answer questions on `IRC and the mail lists </sphinxwiki/content/pages/Twisted/TwistedCommunity.html>`_)
* Sign up for a `project job </sphinxwiki/content/pages/ProjectJobs.html>`_. Help us maintain our build CI, speed center, Trac instance, and more.

Wiki Portals
============

* `Infrastructure </sphinxwiki/content/pages/Infrastructure.html>`_
* `ContinuousIntegration </sphinxwiki/content/pages/ContinuousIntegration.html>`_
* `users </sphinxwiki/content/pages/Users/index.html>`_
* `DocumentationAnalysis </sphinxwiki/content/pages/DocumentationAnalysis.html>`_