Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed #14702 -- Added a "needsinfo" resolution to Trac, and added sup…

…porting documentation on the new resolution and closing tickets in general.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@15665 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 2b7b4683257c072f74b03358ccc368831b872671 1 parent 28123d7
authored February 27, 2011
35  docs/howto/contribute.txt
@@ -64,6 +64,8 @@ However, Trac can be quite confusing even to veteran contributors.  Having to
64 64
 look at both flags and triage stages isn't immediately obvious, and the stages
65 65
 themselves can be misinterpreted.
66 66
 
  67
+.. _triage-stages-explained:
  68
+
67 69
 What Django's triage stages "really mean"
68 70
 -----------------------------------------
69 71
 
@@ -135,6 +137,39 @@ will eventually be merged to trunk.  Tickets in this stage generally don't need
135 137
 further work. This may happen in the case of major features/refactors in each
136 138
 release cycle, or as part of the annual Google Summer of Code efforts.
137 139
 
  140
+.. _closing-tickets:
  141
+
  142
+Closing Tickets
  143
+---------------
  144
+
  145
+When a ticket has completed its useful lifecycle, it's time for it to be closed.
  146
+Closing a ticket is a big responsibility, though. You have to be sure that
  147
+the issue is really resolved, and you need to keep in mind that the reporter
  148
+of the ticket may not be happy to have their ticket closed (unless it's fixed,
  149
+of course). If you're not certain about closing a ticket, just leave a comment
  150
+with your thoughts instead.
  151
+
  152
+If you do close a ticket, you should always make sure of the following:
  153
+
  154
+  * Be certain that the issue is resolved.
  155
+
  156
+  * Leave a comment explaining the decision to close the ticket.
  157
+
  158
+  * If there is a way they can improve the ticket to reopen it, let them know.
  159
+
  160
+  * If the ticket is a duplicate, reference the original ticket.
  161
+
  162
+  * **Be polite.** No one likes having their ticket closed. It can be
  163
+    frustrating or even discouraging. The best way to avoid turning people
  164
+    off from contributing to Django is to be polite and friendly and to offer
  165
+    suggestions for how they could improve this ticket and other tickets in the
  166
+    future.
  167
+
  168
+.. seealso::
  169
+
  170
+    The :ref:`contributing reference <ticket-resolutions>` contains a
  171
+    description of each of the available resolutions in Trac.
  172
+
138 173
 Example Trac workflow
139 174
 ---------------------
140 175
 
36  docs/internals/contributing.txt
@@ -276,12 +276,15 @@ We've got two roles in this diagram:
276 276
       Django is a community project, and we encourage `triage by the
277 277
       community`_.
278 278
 
  279
+Triage stages
  280
+-------------
  281
+
279 282
 Second, note the five triage stages:
280 283
 
281  
-    1. A ticket starts as "Unreviewed", meaning that nobody has examined
  284
+    1. A ticket starts as **Unreviewed**, meaning that nobody has examined
282 285
        the ticket.
283 286
 
284  
-    2. "Design decision needed" means "this concept requires a design
  287
+    2. **Design decision needed** means "this concept requires a design
285 288
        decision," which should be discussed either in the ticket comments or on
286 289
        `django-developers`_. The "Design decision needed" step will generally
287 290
        only be used for feature requests. It can also be used for issues
@@ -290,16 +293,16 @@ Second, note the five triage stages:
290 293
        standard) skip this step and move straight to "Accepted".
291 294
 
292 295
     3. Once a ticket is ruled to be approved for fixing, it's moved into the
293  
-       "Accepted" stage. This stage is where all the real work gets done.
  296
+       **Accepted** stage. This stage is where all the real work gets done.
294 297
 
295  
-    4. In some cases, a ticket might get moved to the "Someday/Maybe" state.
  298
+    4. In some cases, a ticket might get moved to the **Someday/Maybe** state.
296 299
        This means the ticket is an enhancement request that we might consider
297 300
        adding to the framework if an excellent patch is submitted. These
298 301
        tickets are not a high priority.
299 302
 
300 303
     5. If a ticket has an associated patch (see below), it will be reviewed
301  
-       by the community. If the patch is complete, it'll be marked as "ready
302  
-       for checkin" so that a core developer knows to review and commit the
  304
+       by the community. If the patch is complete, it'll be marked as **Ready
  305
+       for checkin** so that a core developer knows to review and commit the
303 306
        patch.
304 307
 
305 308
 The second part of this workflow involves a set of flags the describe what the
@@ -324,6 +327,17 @@ ticket has or needs in order to be "ready for checkin":
324 327
         cleanly, there is a flaw in the implementation, or that the code
325 328
         doesn't meet our standards.
326 329
 
  330
+.. seealso::
  331
+
  332
+    The :ref:`contributing howto guide <triage-stages-explained>` has a detailed
  333
+    explanation of each of the triage stages and how the triage process works in
  334
+    Trac.
  335
+
  336
+.. _ticket-resolutions:
  337
+
  338
+Ticket Resolutions
  339
+------------------
  340
+
327 341
 A ticket can be resolved in a number of ways:
328 342
 
329 343
     "fixed"
@@ -353,12 +367,22 @@ A ticket can be resolved in a number of ways:
353 367
         Used when the ticket doesn't contain enough detail to replicate
354 368
         the original bug.
355 369
 
  370
+    "needsinfo"
  371
+        Used when the ticket does not contain enough information to replicate
  372
+        the reported issue but is potentially still valid. The ticket
  373
+        should be reopened when more information is supplied.
  374
+
356 375
 If you believe that the ticket was closed in error -- because you're
357 376
 still having the issue, or it's popped up somewhere else, or the triagers have
358 377
 made a mistake -- please reopen the ticket and provide further information.
359 378
 Please do not reopen tickets that have been marked as "wontfix" by core
360 379
 developers.
361 380
 
  381
+.. seealso::
  382
+
  383
+    For more information on what to do when closing a ticket, please see the
  384
+    :ref:`contributing howto guide <closing-tickets>`.
  385
+
362 386
 .. _required details: `Reporting bugs`_
363 387
 .. _good patch: `Patch style`_
364 388
 .. _triage by the community: `Triage by the general community`_

0 notes on commit 2b7b468

Please sign in to comment.
Something went wrong with that request. Please try again.