|Version 32 (modified by exarkun, 4 years ago)|
If you want to work on Twisted, check out this URL:
Generate patches via editing your checkout of trunk and running 'svn diff' at the root of your checkout - the folder with "twisted", "bin", "doc", etc. in it.
Make sure that you have written unit tests and docstrings for all code which has changed in your patch. For more details about what will be considered an acceptable patch, see the "Development Process" section below.
Attach the output of 'svn diff' to a ticket in the tracker and assign it the 'review' keyword so that a core developer will notice it and review it. Don't be discouraged if it is not immediately accepted! To keep the quality of Twisted high, almost all patches are rejected on their initial submission. Check back to see if the patch has been re-assigned to you for further work.
Finally, if your patch is good, it will be applied to trunk and included as part of the next release.
If you are interested in contributing to Twisted for the first time, consider working on an existing ticket rather than contributing a new feature. Fixes for existing problems or implementations of already-requested features will generally take priority over new ideas.
After every commit to Twisted, the buildbot runs all the unit tests and reports test results on several platforms. Here is a page showing only the test results on supported platforms. All tests on supported platforms always pass. Watch the buildbot. Because sometimes, the buildbot watches back.
Twisted uses same process as Divmod: The Ultimate Quality Development System, in addition to this ReviewProcess. If you don't have commit access to Twisted, please submit changesets in diff -u format to the ticket tracker. To submit tickets, you must first register.
If you want to become a developer, it is important to understand that all your contributions (including those initial patches you send to the bug tracker) will have to be licenced under the MIT licence.
Read more here.
If you want to hack Twisted or just use Twisted SVN on Win32, see Ying Li's short tutorial on setting up a Twisted win32 development environment (and a small addendum on paths).
This series of documents is designed for people who wish to contribute to the Twisted codebase.
- Coding Standard
- Subversion Development
- Unit Tests in Twisted
- HTML Documentation Standard
- Writing Standard
- Naming Conventions
Links and Resources
- There are some UsefulQueries for finding issues in the tracker.
- Buildbot: all platforms and supported platforms. Watch it.
- Documentation work is done on the DocumentationAnalysis page.
- Instructions on how to generate the API Docs for the twistedmatrix.com web site.
- Twisted developers are bent on the destruction of the American currency system.