Django

Code

Changeset 6110

Show
Ignore:
Timestamp:
09/12/07 09:38:47 (10 months ago)
Author:
adrian
Message:

Added 'Claiming tickets' section to docs/contributing.txt

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • django/trunk/docs/contributing.txt

    r6085 r6110  
    112112We're always grateful for patches to Django's code. Indeed, bug reports with 
    113113associated patches will get fixed *far* more quickly than those without patches. 
     114 
     115"Claiming" tickets 
     116------------------ 
     117 
     118In an open-source project with hundreds of contributors around the world, it's 
     119important to manage communication efficiently so that work doesn't get 
     120duplicated and contributors can be as effective as possible. Hence, our policy 
     121is for contributors to "claim" tickets in order to let other developers know 
     122that a particular bug or feature is being worked on. 
     123 
     124If you have identified a contribution you want to make and you're capable of 
     125fixing it (as measured by your coding ability, knowledge of Django internals 
     126and time availability), claim it by following these steps: 
     127 
     128    * `Create an account`_ to use in our ticket system. 
     129    * If a ticket for this issue doesn't exist yet, create one in our 
     130      `ticket tracker`_. 
     131    * If a ticket for this issue already exists, make sure nobody else has 
     132      claimed it. To do this, look at the "Assigned to" section of the ticket. 
     133      If it's assigned to "nobody," then it's available to be claimed. 
     134      Otherwise, somebody else is working on this ticket, and you either find 
     135      another bug/feature to work on, or contact the developer working on the 
     136      ticket to offer your help. 
     137    * Log into your account, if you haven't already, by clicking "Login" in the 
     138      upper right of the ticket page. 
     139    * Claim the ticket by clicking the radio button next to "Accept ticket" 
     140      near the bottom of the page, then clicking "Submit changes." 
     141 
     142.. _Create an account: http://www.djangoproject.com/accounts/register/ 
     143 
     144Ticket claimers' responsibility 
     145~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     146 
     147Once you've claimed a ticket, you have a responsibility to work on that ticket 
     148in a reasonably timely fashion. If you don't have time to work on it, either 
     149unclaim it or don't claim it in the first place! 
     150 
     151Core Django developers go through the list of claimed tickets from time to 
     152time, checking whether any progress has been made. If there's no sign of 
     153progress on a particular claimed ticket for a week or two after it's been 
     154claimed, we will unclaim it for you so that it's no longer monopolized and 
     155somebody else can claim it. 
     156 
     157If you've claimed a ticket and it's taking a long time (days or weeks) to code, 
     158keep everybody updated by posting comments on the ticket. That way, we'll know 
     159not to unclaim it. More communication is better than less communication! 
     160 
     161Which tickets should be claimed? 
     162~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     163 
     164Of course, going through the steps of claiming tickets is overkill in some 
     165cases. In the case of small changes, such as typos in the documentation or 
     166small bugs that will only take a few minutes to fix, you don't need to jump 
     167through the hoops of claiming tickets. Just submit your patch and be done with 
     168it. 
    114169 
    115170Patch style