Changes between Version 13 and Version 14 of BasicGuideToContributingCode


Ignore:
Timestamp:
08/01/2016 01:49:09 PM (4 years ago)
Author:
hawkowl
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BasicGuideToContributingCode

    v13 v14  
    1 = So, you want to contribute to Twisted? =
    2 
    3 First, a few recommendations:
    4   * Hang out on IRC and ask questions
    5     * [irc://irc.freenode.net/twisted #twisted]
    6     * [irc://irc.freenode.net/twisted.web #twisted.web]
    7     * [irc://irc.freenode.net/twisted-dev #twisted-dev]
    8   * Search trac for tickets with the [/query?status=new&status=assigned&status=reopened&keywords=%7Eeasy&order=priority '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).
    9 
    10 What you'll need:
    11   * [http://git-scm.com Git] client[[BR]][[BR]]
    12   See [wiki:VcsWorkflows DVCS Workflows] for tips on keeping up-to-date with trunk.
    13 
    14   * [/register Register] with the site and create an account
    15 
    16   * A decent grasp of Twisted and what you intend to accomplish
    17 
    18 
    19 == Just the Basics ==
    20 This assumes you will be working on an existing open [/report/ ticket].
    21 
    22 
    23 === Checkout Source ===
    24 Checkout a fresh copy of Twisted trunk. This is going to be your development branch.[[BR]]
    25 {{{
    26 git clone https://github.com/twisted/twisted twisted-trunk
    27 }}}
    28 
    29 === Hack and Test ===
    30   1. Tests are '''required'''
    31   1. Docstrings are '''required'''
    32 
    33 Hack away and then run the '''''full''''' Twisted test suite and make sure your new tests pass along with entire suite:[[BR]]
    34 {{{
    35 trial twisted
    36 }}}
    37 
    38 === Submit a Patch ===
    39 Follow [[TwistedDevelopment#SubmittingaPatch]]
    40 
    41 === Review Process ===
    42   1. Begin the [wiki:ReviewProcess Review process]. A core developer will review your changes and give you feedback.
    43   1. You respond to the feedback using the ticket, attaching further patches as necessary.
    44   1. Once your patch is in good shape and approved, it will be accepted.
    45   1. A core developer will create a new branch for your ticket: {{{description-1234}}}, where ''description'' is a summary and ''1234'' is the ticket #
    46   1. The new branch will be merged to trunk and your contribution will be forever remembered.
    47 
    48 == Next Steps ==
    49 
    50 Twisted has a rigorous development process. Now that you have a basic idea of the overall process, you can continue reading about [wiki:ContributingToTwistedLabs#Prepare Contributing to Twisted]
     1Please see [wiki:TwistedDevelopment#SubmittingaPatch]!