Skip to content

Commit ced74d5

Browse files
Added 'Claiming tickets' section to docs/contributing.txt
git-svn-id: http://code.djangoproject.com/svn/django/trunk@6110 bcc190cf-cafb-0310-a4f2-bffc1f526a37
1 parent db60936 commit ced74d5

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

docs/contributing.txt

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,61 @@ Submitting patches
112112
We're always grateful for patches to Django's code. Indeed, bug reports with
113113
associated patches will get fixed *far* more quickly than those without patches.
114114

115+
"Claiming" tickets
116+
------------------
117+
118+
In an open-source project with hundreds of contributors around the world, it's
119+
important to manage communication efficiently so that work doesn't get
120+
duplicated and contributors can be as effective as possible. Hence, our policy
121+
is for contributors to "claim" tickets in order to let other developers know
122+
that a particular bug or feature is being worked on.
123+
124+
If you have identified a contribution you want to make and you're capable of
125+
fixing it (as measured by your coding ability, knowledge of Django internals
126+
and 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+
144+
Ticket claimers' responsibility
145+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
146+
147+
Once you've claimed a ticket, you have a responsibility to work on that ticket
148+
in a reasonably timely fashion. If you don't have time to work on it, either
149+
unclaim it or don't claim it in the first place!
150+
151+
Core Django developers go through the list of claimed tickets from time to
152+
time, checking whether any progress has been made. If there's no sign of
153+
progress on a particular claimed ticket for a week or two after it's been
154+
claimed, we will unclaim it for you so that it's no longer monopolized and
155+
somebody else can claim it.
156+
157+
If you've claimed a ticket and it's taking a long time (days or weeks) to code,
158+
keep everybody updated by posting comments on the ticket. That way, we'll know
159+
not to unclaim it. More communication is better than less communication!
160+
161+
Which tickets should be claimed?
162+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
163+
164+
Of course, going through the steps of claiming tickets is overkill in some
165+
cases. In the case of small changes, such as typos in the documentation or
166+
small bugs that will only take a few minutes to fix, you don't need to jump
167+
through the hoops of claiming tickets. Just submit your patch and be done with
168+
it.
169+
115170
Patch style
116171
-----------
117172

0 commit comments

Comments
 (0)