Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 3.43 KB

ContributingToTwistedLabs.mediawiki

File metadata and controls

55 lines (41 loc) · 3.43 KB
Raw

Table of Contents

Contributing To Twisted

PageOutline(1-100,,inline)

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 and can be made via "Google Checkout or Paypal" or directly to the Twisted Software Foundation.

Code Contributions

[#Overview]

 * [wiki:TwistedDevelopment#SubmittingaPatch Submitting a Patch], a simplified overview
 * [wiki:TwistedDevelopment Detailed Contribution Requirements], with that and more
 * [wiki:ReviewProcess Our Review Process], how contributed code is quality checked and reviewed 
 * [wiki:CommitterCheckList Checklist for Twisted committers], things that developers with commit access should know

[#Prepare]

  * Get a GitHub account and then come back and [/github/login Login using GitHub] on this site
  * Intimately familiarize yourself with [UltimateQualityDevelopmentSystem The Ultimate Quality Development System]
  * Understand the [wiki:Documentation Developer docs] (how-tos, core docs, examples, API reference)
  * Twisted has a rigorous policy standards for code, documentation, and testing:
    * [http://twistedmatrix.com/documents/current/core/development/policy/coding-standard.html Coding standard]
    * [http://twistedmatrix.com/documents/current/core/development/policy/writing-standard.html Writing Style guide]
    * [http://twistedmatrix.com/documents/current/core/development/policy/test-standard.html Testing standard]
    * [https://github.com/twisted/twisted/blob/trunk/docs/core/development/policy/code-dev.rst Git Access]
  * Understand the [wiki:ReviewProcess 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]

  * Examine some of the [source:branches current branches]
  * Take a look at the [/report open tickets]
  * Learn the [wiki:BugKeywords bug keywords]
    * [/query?status=new&status=assigned&status=reopened&keywords=%7Eeasy&order=priority 'Easy' keyword tickets] are low-hanging fruit and good to get your feet wet
  * [wiki:TwistedDevelopment#SubmittingaPatch Submit a Patch]
  * Learn how to apply for commit privileges with the [wiki:ContributorAdvancementPath Contributor Advancement Path]

[#OtherWays]

 * [wiki:ReviewingDocumentation Review and add documentation]
 * [wiki:ReviewProcess Code Reviews] 
 * Submit bug reports (you must first be [/register registered])  
 * Provide technical support (answer questions on [TwistedCommunity IRC and the mail lists])
 * Sign up for a [wiki:ProjectJobs project job]. Help us maintain our build CI, speed center, Trac instance, and more.

Wiki Portals

 * [wiki:Infrastructure]
 * [wiki:ContinuousIntegration]
 * [wiki:users]
 * [wiki:DocumentationAnalysis]